javax.slee.management
Class ServiceStateChangeNotification

java.lang.Object
  extended by java.util.EventObject
      extended by javax.management.Notification
          extended by javax.slee.management.ServiceStateChangeNotification
All Implemented Interfaces:
java.io.Serializable, VendorExtensions

public final class ServiceStateChangeNotification
extends javax.management.Notification
implements VendorExtensions

This notification is emitted by a ServiceManagementMBean object to indicate a change in the operational state of a Service.

The notification type of Service state change notifications is specified by the ServiceManagementMBean.SERVICE_STATE_CHANGE_NOTIFICATION_TYPE attribute.

Since:
SLEE 1.1
See Also:
Serialized Form

Field Summary
 
Fields inherited from class javax.management.Notification
source
 
Constructor Summary
ServiceStateChangeNotification(ServiceManagementMBean serviceManagementMBean, ServiceID service, ServiceState newState, ServiceState oldState, long sequenceNumber)
          Create a ServiceStateChangeNotification to notify listeners of a change in the operational state of a Service.
 
Method Summary
static void disableVendorDataDeserialization()
          Disable the deserialization of vendor-specific data for objects of this class.
static void disableVendorDataSerialization()
          Disable the serialization of vendor-specific data for objects of this class.
static void enableVendorDataDeserialization()
          Enable the deserialization of vendor-specific data for objects of this class.
static void enableVendorDataSerialization()
          Enable the serialization of vendor-specific data for objects of this class.
 ServiceState getNewState()
          Get the new operational state of the Service.
 ServiceState getOldState()
          Get the state the Service was in before the change to the new state.
 ServiceID getService()
          Get the component identifier of the Service that has changed state.
 java.lang.Object getVendorData()
          Get the vendor-specific data.
 void setVendorData(java.lang.Object vendorData)
          Set the vendor-specific data.
 java.lang.String toString()
          Get a string representation for this notification.
 
Methods inherited from class javax.management.Notification
getMessage, getSequenceNumber, getTimeStamp, getType, getUserData, setSequenceNumber, setSource, setTimeStamp, setUserData
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ServiceStateChangeNotification

public ServiceStateChangeNotification(ServiceManagementMBean serviceManagementMBean,
                                      ServiceID service,
                                      ServiceState newState,
                                      ServiceState oldState,
                                      long sequenceNumber)
                               throws java.lang.NullPointerException
Create a ServiceStateChangeNotification to notify listeners of a change in the operational state of a Service. Notifications are broadcast after the Service has changed to the new state.

Parameters:
serviceManagementMBean - the ServiceManagementMBean object that is emitting this notification.
service - the component identifier of the Service that has changed state.
newState - the new operational state of the Service.
oldState - the old operational state of the Service.
sequenceNumber - the notification sequence number within the source ServiceManagementMBean object.
Throws:
java.lang.NullPointerException - if notificationSource, service, newState, or oldState is null.
Method Detail

getService

public ServiceID getService()
Get the component identifier of the Service that has changed state.

Returns:
the Service component identifier.

getNewState

public ServiceState getNewState()
Get the new operational state of the Service.

Returns:
the new state.

getOldState

public ServiceState getOldState()
Get the state the Service was in before the change to the new state.

Returns:
the old state.

enableVendorDataSerialization

public static void enableVendorDataSerialization()
Enable the serialization of vendor-specific data for objects of this class. This method is typically used by a SLEE implementation that wants to export vendor-specific data with objects of this class to management clients.

By default, any vendor-specific data included in an object of this class will not be included in the serialization stream when the object is serialized. Invoking this method changes this behavior so that vendor-specific data is included in the serialization stream when an object of this class is serialized.

This method should only be invoked if the vendor-specific data is serializable via standard Java serialization means.

See Also:
disableVendorDataSerialization(), setVendorData(java.lang.Object)

disableVendorDataSerialization

public static void disableVendorDataSerialization()
Disable the serialization of vendor-specific data for objects of this class.

If the serialization of vendor-specific data for objects of this class has been enabled via the enableVendorDataSerialization() method, this method disables that behavior again.


enableVendorDataDeserialization

public static void enableVendorDataDeserialization()
Enable the deserialization of vendor-specific data for objects of this class. This method is typically used by a management client that wants to obtain any vendor-specific data included in the serialization stream of objects of this class.

By default, any vendor-specific data included in the serialization stream of objects of this class is discarded upon deserialization. Invoking this method changes that behavior so that the vendor-specific data is also deserialized when an object of this class is deserialized. A management client that enables the deserialization of vendor-specific data must ensure that any necessary classes required to deserialize that data is available in the relevant classloader.

See Also:
disableVendorDataDeserialization(), getVendorData()

disableVendorDataDeserialization

public static void disableVendorDataDeserialization()
Disable the deserialization of vendor-specific data for objects of this class.

If the deserialization of vendor-specific data for objects of this class has been enabled via the enableVendorDataDeserialization() method, this method disables that behavior again.


setVendorData

public void setVendorData(java.lang.Object vendorData)
Set the vendor-specific data.

Specified by:
setVendorData in interface VendorExtensions
Parameters:
vendorData - the vendor-specific data.

getVendorData

public java.lang.Object getVendorData()
Get the vendor-specific data.

Specified by:
getVendorData in interface VendorExtensions
Returns:
the vendor-specific data.

toString

public java.lang.String toString()
Get a string representation for this notification.

Overrides:
toString in class javax.management.Notification
Returns:
a string representation for this notification.


Copyright © 2008. All Rights Reserved.