relationservicembean.html

j2ee的API 1.4版本,j2ee的帮助文档

<DL>
<DD>Returns the relation id associated to the given ObjectName if the
 MBean has been added as a relation in the Relation Service.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>theObjName</CODE> - ObjectName of supposed relation
<DT><B>Returns:</B><DD>relation id (String) or null (if the ObjectName is not a
 relation handled by the Relation Service)
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if null parameter</DL>
</DD>
</DL>
<HR>

<A NAME="hasRelation(java.lang.String)"><!-- --></A><H3>
hasRelation</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Boolean.html" title="class or interface in java.lang">Boolean</A> <B>hasRelation</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;theRelId)
                    throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
<DL>
<DD>Checks if there is a relation identified in Relation Service with given
 relation id.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>theRelId</CODE> - relation id identifying the relation
<DT><B>Returns:</B><DD>boolean: true if there is a relation, false else
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if null parameter</DL>
</DD>
</DL>
<HR>

<A NAME="getAllRelationIds()"><!-- --></A><H3>
getAllRelationIds</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/List.html" title="class or interface in java.util">List</A> <B>getAllRelationIds</B>()</PRE>
<DL>
<DD>Returns all the relation ids for all the relations handled by the
 Relation Service.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>ArrayList of String</DL>
</DD>
</DL>
<HR>

<A NAME="checkRoleReading(java.lang.String, java.lang.String)"><!-- --></A><H3>
checkRoleReading</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Integer.html" title="class or interface in java.lang">Integer</A> <B>checkRoleReading</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;theRoleName,
                                <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;theRelTypeName)
                         throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A>,
                                <A HREF="../../../javax/management/relation/RelationTypeNotFoundException.html" title="class in javax.management.relation">RelationTypeNotFoundException</A></PRE>
<DL>
<DD>Checks if given Role can be read in a relation of the given type.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>theRoleName</CODE> - name of role to be checked<DD><CODE>theRelTypeName</CODE> - name of the relation type
<DT><B>Returns:</B><DD>an Integer wrapping an integer corresponding to possible
 problems represented as constants in RoleUnresolved:
 <P>- 0 if role can be read
 <P>- integer corresponding to RoleStatus.NO_ROLE_WITH_NAME
 <P>- integer corresponding to RoleStatus.ROLE_NOT_READABLE
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if null parameter
<DD><CODE><A HREF="../../../javax/management/relation/RelationTypeNotFoundException.html" title="class in javax.management.relation">RelationTypeNotFoundException</A></CODE> - if the relation type is not
 known in the Relation Service</DL>
</DD>
</DL>
<HR>

<A NAME="checkRoleWriting(javax.management.relation.Role, java.lang.String, java.lang.Boolean)"><!-- --></A><H3>
checkRoleWriting</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Integer.html" title="class or interface in java.lang">Integer</A> <B>checkRoleWriting</B>(<A HREF="../../../javax/management/relation/Role.html" title="class in javax.management.relation">Role</A>&nbsp;theRole,
                                <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;theRelTypeName,
                                <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Boolean.html" title="class or interface in java.lang">Boolean</A>&nbsp;theInitFlg)
                         throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A>,
                                <A HREF="../../../javax/management/relation/RelationTypeNotFoundException.html" title="class in javax.management.relation">RelationTypeNotFoundException</A></PRE>
<DL>
<DD>Checks if given Role can be set in a relation of given type.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>theRole</CODE> - role to be checked<DD><CODE>theRelTypeName</CODE> - name of relation type<DD><CODE>theInitFlg</CODE> - flag to specify that the checking is done for the
 initialization of a role, write access shall not be verified.
<DT><B>Returns:</B><DD>an Integer wrapping an integer corresponding to possible
 problems represented as constants in RoleUnresolved:
 <P>- 0 if role can be set
 <P>- integer corresponding to RoleStatus.NO_ROLE_WITH_NAME
 <P>- integer for RoleStatus.ROLE_NOT_WRITABLE
 <P>- integer for RoleStatus.LESS_THAN_MIN_ROLE_DEGREE
 <P>- integer for RoleStatus.MORE_THAN_MAX_ROLE_DEGREE
 <P>- integer for RoleStatus.REF_MBEAN_OF_INCORRECT_CLASS
 <P>- integer for RoleStatus.REF_MBEAN_NOT_REGISTERED
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if null parameter
<DD><CODE><A HREF="../../../javax/management/relation/RelationTypeNotFoundException.html" title="class in javax.management.relation">RelationTypeNotFoundException</A></CODE> - if unknown relation type</DL>
</DD>
</DL>
<HR>

<A NAME="sendRelationCreationNotification(java.lang.String)"><!-- --></A><H3>
sendRelationCreationNotification</H3>
<PRE>
public void <B>sendRelationCreationNotification</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;theRelId)
                                      throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A>,
                                             <A HREF="../../../javax/management/relation/RelationNotFoundException.html" title="class in javax.management.relation">RelationNotFoundException</A></PRE>
<DL>
<DD>Sends a notification (RelationNotification) for a relation creation.
 The notification type is:
 <P>- RelationNotification.RELATION_BASIC_CREATION if the relation is an
 object internal to the Relation Service
 <P>- RelationNotification.RELATION_MBEAN_CREATION if the relation is a
 MBean added as a relation.
 <P>The source object is the Relation Service itself.
 <P>It is called in Relation Service createRelation() and
 addRelation() methods.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>theRelId</CODE> - relation identifier of the updated relation
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if null parameter
<DD><CODE><A HREF="../../../javax/management/relation/RelationNotFoundException.html" title="class in javax.management.relation">RelationNotFoundException</A></CODE> - if there is no relation for given
 relation id</DL>
</DD>
</DL>
<HR>

<A NAME="sendRoleUpdateNotification(java.lang.String, javax.management.relation.Role, java.util.List)"><!-- --></A><H3>
sendRoleUpdateNotification</H3>
<PRE>
public void <B>sendRoleUpdateNotification</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;theRelId,
                                       <A HREF="../../../javax/management/relation/Role.html" title="class in javax.management.relation">Role</A>&nbsp;theNewRole,
                                       <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&nbsp;theOldRoleValue)
                                throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A>,
                                       <A HREF="../../../javax/management/relation/RelationNotFoundException.html" title="class in javax.management.relation">RelationNotFoundException</A></PRE>
<DL>
<DD>Sends a notification (RelationNotification) for a role update in the
 given relation. The notification type is:
 <P>- RelationNotification.RELATION_BASIC_UPDATE if the relation is an
 object internal to the Relation Service
 <P>- RelationNotification.RELATION_MBEAN_UPDATE if the relation is a
 MBean added as a relation.
 <P>The source object is the Relation Service itself.
 <P>It is called in relation MBean setRole() (for given role) and
 setRoles() (for each role) methods (implementation provided in
 RelationSupport class).
 <P>It is also called in Relation Service setRole() (for given role) and
 setRoles() (for each role) methods.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>theRelId</CODE> - relation identifier of the updated relation<DD><CODE>theNewRole</CODE> - new role (name and new value)<DD><CODE>theOldRoleValue</CODE> - old role value (ArrayList of ObjectName objects)
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if null parameter
<DD><CODE><A HREF="../../../javax/management/relation/RelationNotFoundException.html" title="class in javax.management.relation">RelationNotFoundException</A></CODE> - if there is no relation for given
 relation id</DL>
</DD>
</DL>
<HR>

<A NAME="sendRelationRemovalNotification(java.lang.String, java.util.List)"><!-- --></A><H3>
sendRelationRemovalNotification</H3>
<PRE>
public void <B>sendRelationRemovalNotification</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;theRelId,
                                            <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&nbsp;theUnregMBeanList)
                                     throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A>,
                                            <A HREF="../../../javax/management/relation/RelationNotFoundException.html" title="class in javax.management.relation">RelationNotFoundException</A></PRE>
<DL>
<DD>Sends a notification (RelationNotification) for a relation removal.
 The notification type is:
 <P>- RelationNotification.RELATION_BASIC_REMOVAL if the relation is an
 object internal to the Relation Service
 <P>- RelationNotification.RELATION_MBEAN_REMOVAL if the relation is a
 MBean added as a relation.
 <P>The source object is the Relation Service itself.
 <P>It is called in Relation Service removeRelation() method.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>theRelId</CODE> - relation identifier of the updated relation<DD><CODE>theUnregMBeanList</CODE> - ArrayList of ObjectNames of MBeans expected
 to be unregistered due to relation removal (can be null)
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if null parameter
<DD><CODE><A HREF="../../../javax/management/relation/RelationNotFoundException.html" title="class in javax.management.relation">RelationNotFoundException</A></CODE> - if there is no relation for given
 relation id</DL>
</DD>
</DL>
<HR>

<A NAME="updateRoleMap(java.lang.String, javax.management.relation.Role, java.util.List)"><!-- --></A><H3>
updateRoleMap</H3>
<PRE>
public void <B>updateRoleMap</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;theRelId,
                          <A HREF="../../../javax/management/relation/Role.html" title="class in javax.management.relation">Role</A>&nbsp;theNewRole,
                          <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&nbs