This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.management.relation
class RelationNotification

java.lang.Object extended by java.util.EventObject extended by javax.management.Notification extended by javax.management.relation.RelationNotification
All Implemented Interfaces:
Serializable

public class RelationNotification
extends Notification

A notification of a change in the Relation Service. A RelationNotification notification is sent when a relation is created via the Relation Service, or an MBean is added as a relation in the Relation Service, or a role is updated in a relation, or a relation is removed from the Relation Service.

The serialVersionUID of this class is -6871117877523310399L.


Field Summary
static String RELATION_BASIC_CREATION
          Type for the creation of an internal relation.
static String RELATION_BASIC_REMOVAL
          Type for the removal from the Relation Service of an internal relation.
static String RELATION_BASIC_UPDATE
          Type for an update of an internal relation.
static String RELATION_MBEAN_CREATION
          Type for the relation MBean added into the Relation Service.
static String RELATION_MBEAN_REMOVAL
          Type for the removal from the Relation Service of a relation MBean.
static String RELATION_MBEAN_UPDATE
          Type for the update of a relation MBean.
 
Fields inherited from class javax.management.Notification
source
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
RelationNotification(String notifType, Object sourceObj, long sequence, long timeStamp, String message, String id, String typeName, ObjectName objectName, List unregMBeanList)

          Creates a notification for either a relation creation (RelationSupport object created internally in the Relation Service, or an MBean added as a relation) or for a relation removal from the Relation Service.
RelationNotification(String notifType, Object sourceObj, long sequence, long timeStamp, String message, String id, String typeName, ObjectName objectName, String name, List newValue, List oldValue)

          Creates a notification for a role update in a relation.
 
Method Summary
 List

          Returns the list of ObjectNames of MBeans expected to be unregistered due to a relation removal (only for relation removal).
 List

          Returns new value of updated role (only for role update).
 ObjectName

          Returns the ObjectName of the created/removed/updated relation.
 List

          Returns old value of updated role (only for role update).
 String

          Returns the relation identifier of created/removed/updated relation.
 String

          Returns the relation type name of created/removed/updated relation.
 String

          Returns name of updated role of updated relation (only for role update).
 
Methods inherited from class javax.management.Notification
getMessage, getSequenceNumber, getTimeStamp, getType, getUserData, setSequenceNumber, setSource, setTimeStamp, setUserData, toString
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RELATION_BASIC_CREATION

public static final String RELATION_BASIC_CREATION
Type for the creation of an internal relation.

RELATION_BASIC_REMOVAL

public static final String RELATION_BASIC_REMOVAL
Type for the removal from the Relation Service of an internal relation.

RELATION_BASIC_UPDATE

public static final String RELATION_BASIC_UPDATE
Type for an update of an internal relation.

RELATION_MBEAN_CREATION

public static final String RELATION_MBEAN_CREATION
Type for the relation MBean added into the Relation Service.

RELATION_MBEAN_REMOVAL

public static final String RELATION_MBEAN_REMOVAL
Type for the removal from the Relation Service of a relation MBean.

RELATION_MBEAN_UPDATE

public static final String RELATION_MBEAN_UPDATE
Type for the update of a relation MBean.
Constructor Detail

RelationNotification

public RelationNotification(String notifType,
                            Object sourceObj,
                            long sequence,
                            long timeStamp,
                            String message,
                            String id,
                            String typeName,
                            ObjectName objectName,
                            List unregMBeanList)
                     throws IllegalArgumentException
Creates a notification for either a relation creation (RelationSupport object created internally in the Relation Service, or an MBean added as a relation) or for a relation removal from the Relation Service.

Parameters:
notifType - type of the notification; either:

- RELATION_BASIC_CREATION

- RELATION_MBEAN_CREATION

- RELATION_BASIC_REMOVAL

- RELATION_MBEAN_REMOVAL

sourceObj - source object, sending the notification. This is either an ObjectName or a RelationService object. In the latter case it must be the MBean emitting the notification; the MBean Server will rewrite the source to be the ObjectName under which that MBean is registered.
sequence - sequence number to identify the notification
timeStamp - time stamp
message - human-readable message describing the notification
id - relation id identifying the relation in the Relation Service
typeName - name of the relation type
objectName - ObjectName of the relation object if it is an MBean (null for relations internally handled by the Relation Service)
unregMBeanList - list of ObjectNames of referenced MBeans expected to be unregistered due to relation removal (only for removal, due to CIM qualifiers, can be null)
Throws:
IllegalArgumentException - if:

- no value for the notification type

- the notification type is not RELATION_BASIC_CREATION, RELATION_MBEAN_CREATION, RELATION_BASIC_REMOVAL or RELATION_MBEAN_REMOVAL

- no source object

- the source object is not a Relation Service

- no relation id

- no relation type name


RelationNotification

public RelationNotification(String notifType,
                            Object sourceObj,
                            long sequence,
                            long timeStamp,
                            String message,
                            String id,
                            String typeName,
                            ObjectName objectName,
                            String name,
                            List newValue,
                            List oldValue)
                     throws IllegalArgumentException
Creates a notification for a role update in a relation.

Parameters:
notifType - type of the notification; either:

- RELATION_BASIC_UPDATE

- RELATION_MBEAN_UPDATE

sourceObj - source object, sending the notification. This is either an ObjectName or a RelationService object. In the latter case it must be the MBean emitting the notification; the MBean Server will rewrite the source to be the ObjectName under which that MBean is registered.
sequence - sequence number to identify the notification
timeStamp - time stamp
message - human-readable message describing the notification
id - relation id identifying the relation in the Relation Service
typeName - name of the relation type
objectName - ObjectName of the relation object if it is an MBean (null for relations internally handled by the Relation Service)
name - name of the updated role
newValue - new role value (List of ObjectName objects)
oldValue - old role value (List of ObjectName objects)
Throws:
IllegalArgumentException - if null parameter
Method Detail

getMBeansToUnregister

public List getMBeansToUnregister()
Returns the list of ObjectNames of MBeans expected to be unregistered due to a relation removal (only for relation removal).

Returns:
a {@link List} of {@link ObjectName}.

getNewRoleValue

public List getNewRoleValue()
Returns new value of updated role (only for role update).

Returns:
the new value of the updated role.

getObjectName

public ObjectName getObjectName()
Returns the ObjectName of the created/removed/updated relation.

Returns:
the ObjectName if the relation is an MBean, otherwise null.

getOldRoleValue

public List getOldRoleValue()
Returns old value of updated role (only for role update).

Returns:
the old value of the updated role.

getRelationId

public String getRelationId()
Returns the relation identifier of created/removed/updated relation.

Returns:
the relation id.

getRelationTypeName

public String getRelationTypeName()
Returns the relation type name of created/removed/updated relation.

Returns:
the relation type name.

getRoleName

public String getRoleName()
Returns name of updated role of updated relation (only for role update).

Returns:
the name of the updated role.


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.