站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > JBoss 4.0.1 sp1 jmx API Documentation 英文版文档

RelationNotification (JBoss/JMX API) - JBoss 4.0.1 sp1 jmx API Documentation 英文版文档

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

javax.management.relation
Class RelationNotification

java.lang.Object
  extended byjava.util.EventObject
      extended byjavax.management.Notification
          extended byjavax.management.relation.RelationNotification
All Implemented Interfaces:
Serializable
public class RelationNotification
extends Notification

A notification from the relation service.

Version:
$Revision: 1.9 $

Revisions:

20020715 Adrian Brock:

  • Serialization
Author:
Adrian Brock
See Also:
Serialized Form

Field Summary
static String RELATION_BASIC_CREATION
          Creation of an internal relation.
static String RELATION_BASIC_REMOVAL
          Removal of an internal relation.
static String RELATION_BASIC_UPDATE
          Update of an internal relation.
static String RELATION_MBEAN_CREATION
          Creation of MBean relation added to the relation service.
static String RELATION_MBEAN_REMOVAL
          Removal of MBean relation added to the relation service.
static String RELATION_MBEAN_UPDATE
          Update of MBean relation added to the relation service.
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
RelationNotification(String type, Object source, long sequenceNumber, long timeStamp, String message, String relationId, String relTypeName, ObjectName relObjName, List unregMBeans)
          Construct a new relation notification for a creation or removal.
RelationNotification(String type, Object source, long sequenceNumber, long timeStamp, String message, String relationId, String relTypeName, ObjectName relObjName, String roleName, List newRoleValue, List oldRoleValue)
          Construct a new relation notification for an update.
 
Method Summary
 List getMBeansToUnregister()
          Retrieves a list of Object names of the mbeans that will be removed from the relation service because of a relation's removal.
 List getNewRoleValue()
          Retrieves the new list of object names in the role.
 ObjectName getObjectName()
          Retrieves the object name of the mbean (null for an internal relation).
 List getOldRoleValue()
          Retrieves the old list of object names in the role.
 String getRelationId()
          Retrieves the relation id of this notification.
 String getRelationTypeName()
          Retrieves the relation type name of this notification.
 String getRoleName()
          Retrieves the role name of an updated role, only for role updates.
 
Methods inherited from class javax.management.Notification
getMessage, getSequenceNumber, getSource, getTimeStamp, getType, getUserData, setSequenceNumber, setSource, setTimeStamp, setUserData, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

RELATION_BASIC_CREATION

public static final String RELATION_BASIC_CREATION
Creation of an internal relation.

See Also:
Constant Field Values

RELATION_BASIC_REMOVAL

public static final String RELATION_BASIC_REMOVAL
Removal of an internal relation.

See Also:
Constant Field Values

RELATION_BASIC_UPDATE

public static final String RELATION_BASIC_UPDATE
Update of an internal relation.

See Also:
Constant Field Values

RELATION_MBEAN_CREATION

public static final String RELATION_MBEAN_CREATION
Creation of MBean relation added to the relation service.

See Also:
Constant Field Values

RELATION_MBEAN_REMOVAL

public static final String RELATION_MBEAN_REMOVAL
Removal of MBean relation added to the relation service.

See Also:
Constant Field Values

RELATION_MBEAN_UPDATE

public static final String RELATION_MBEAN_UPDATE
Update of MBean relation added to the relation service.

See Also:
Constant Field Values
Constructor Detail

RelationNotification

public RelationNotification(String type,
                            Object source,
                            long sequenceNumber,
                            long timeStamp,
                            String message,
                            String relationId,
                            String relTypeName,
                            ObjectName relObjName,
                            List unregMBeans)
                     throws IllegalArgumentException
Construct a new relation notification for a creation or removal.

The notification type should be one RELATION_BASIC_CREATION, RELATION_BASIC_REMOVAL, RELATION_MBEAN_CREATION or RELATION_MBEAN_REMOVAL.

The relation type cannot be null, the source cannot be null and it must be a relation service, the relation id cannot be null, the relation type name cannot null.

Parameters:
type - the notification type.
source - the object sending the notification (always the the relation service).
sequenceNumber - the number identifying the notification
timeStamp - the time of the notification
message - human readable string
relationId - the relation id
relTypeName - the relation type name
relObjName - the relation MBean object name (null for internal relations)
unregMBeans - the list of object names of mbeans to be unregistered from the relation service because of a relation removal. Only relevant for removals, can be null.
Throws:
IllegalArgumentException - for null or invalid parameters.

RelationNotification

public RelationNotification(String type,
                            Object source,
                            long sequenceNumber,
                            long timeStamp,
                            String message,
                            String relationId,
                            String relTypeName,
                            ObjectName relObjName,
                            String roleName,
                            List newRoleValue,
                            List oldRoleValue)
                     throws IllegalArgumentException
Construct a new relation notification for an update.

The notification type should be one RELATION_BASIC_UPDATE, RELATION_MBEAN_UPDATE The relation type cannot be null, the source cannot be null and it must be a relation service, the relation id cannot be null, the relation type name cannot null.

Parameters:
type - the notification type.
source - the object sending the notification (always the the relation service).
sequenceNumber - the number identifying the notification
timeStamp - the time of the notification
message - human readable string
relationId - the relation id
relTypeName - the relation type name
relObjName - the relation MBean object name (null for internal relations)
roleName - the role name
newRoleValue - the new value of the role
Throws:
IllegalArgumentException - for null or invalid parameters.
Method Detail

getMBeansToUnregister

public List getMBeansToUnregister()
Retrieves a list of Object names of the mbeans that will be removed from the relation service because of a relation's removal. This is only relevant for relation removal events.

Returns:
the list of removed mbeans.

getNewRoleValue

public List getNewRoleValue()
Retrieves the new list of object names in the role.

Returns:
the new list.

getObjectName

public ObjectName getObjectName()
Retrieves the object name of the mbean (null for an internal relation).

Returns:
the relation's object name.

getOldRoleValue

public List getOldRoleValue()
Retrieves the old list of object names in the role.

Returns:
the old list.

getRelationId

public String getRelationId()
Retrieves the relation id of this notification.

Returns:
the relation id.

getRelationTypeName

public String getRelationTypeName()
Retrieves the relation type name of this notification.

Returns:
the relation type name.

getRoleName

public String getRoleName()
Retrieves the role name of an updated role, only for role updates.

Returns:
the name of the updated role.
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2002 JBoss Group, LLC. All Rights Reserved.