componentmanager.html

开源软件openfire的API文件。进行openfire的二次开发所必需的工具。

<DT><B>Parameters:</B><DD><CODE>subdomain</CODE> - the subdomain of the component's address.<DD><CODE>component</CODE> - the component.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/xmpp/component/ComponentException.html" title="class in org.xmpp.component">ComponentException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="removeComponent(java.lang.String)"><!-- --></A><H3>
removeComponent</H3>
<PRE>
void <B>removeComponent</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;subdomain)
                     throws <A HREF="../../../org/xmpp/component/ComponentException.html" title="class in org.xmpp.component">ComponentException</A></PRE>
<DL>
<DD>Removes a component. The <A HREF="../../../org/xmpp/component/Component.html#shutdown()"><CODE>Component.shutdown()</CODE></A> method will be called on the
 component.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>subdomain</CODE> - the subdomain of the component's address.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/xmpp/component/ComponentException.html" title="class in org.xmpp.component">ComponentException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="sendPacket(org.xmpp.component.Component, org.xmpp.packet.Packet)"><!-- --></A><H3>
sendPacket</H3>
<PRE>
void <B>sendPacket</B>(<A HREF="../../../org/xmpp/component/Component.html" title="interface in org.xmpp.component">Component</A>&nbsp;component,
                <A HREF="../../../org/xmpp/packet/Packet.html" title="class in org.xmpp.packet">Packet</A>&nbsp;packet)
                throws <A HREF="../../../org/xmpp/component/ComponentException.html" title="class in org.xmpp.component">ComponentException</A></PRE>
<DL>
<DD>Sends a packet to the XMPP server. The "from" value of the packet must not be null.
 An <tt>IllegalArgumentException</tt> will be thrown when the "from" value is null.<p>

 Components are trusted by the server and may use any value in from address. Usually
 the from address uses the component's address as the domain but this is not required.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>component</CODE> - the component sending the packet.<DD><CODE>packet</CODE> - the packet to send.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/xmpp/component/ComponentException.html" title="class in org.xmpp.component">ComponentException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="query(org.xmpp.component.Component, org.xmpp.packet.IQ, int)"><!-- --></A><H3>
query</H3>
<PRE>
<A HREF="../../../org/xmpp/packet/IQ.html" title="class in org.xmpp.packet">IQ</A> <B>query</B>(<A HREF="../../../org/xmpp/component/Component.html" title="interface in org.xmpp.component">Component</A>&nbsp;component,
         <A HREF="../../../org/xmpp/packet/IQ.html" title="class in org.xmpp.packet">IQ</A>&nbsp;packet,
         int&nbsp;timeout)
         throws <A HREF="../../../org/xmpp/component/ComponentException.html" title="class in org.xmpp.component">ComponentException</A></PRE>
<DL>
<DD>Sends an IQ packet to the XMPP server and waits to get an IQ of type result or error.
 The "from" value of the packet must not be null. An <tt>IllegalArgumentException</tt>
 will be thrown when the "from" value is null.<p>

 Components are trusted by the server and may use any value in from address. Usually
 the from address uses the component's address as the domain but this is not required.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>component</CODE> - the component sending the packet.<DD><CODE>packet</CODE> - the IQ packet to send.<DD><CODE>timeout</CODE> - the number of milliseconds to wait before returning an IQ error.
<DT><B>Returns:</B><DD>the answer sent by the server. The answer could be an IQ of type result or
         error or null if nothing was received.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/xmpp/component/ComponentException.html" title="class in org.xmpp.component">ComponentException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="query(org.xmpp.component.Component, org.xmpp.packet.IQ, org.jivesoftware.openfire.IQResultListener)"><!-- --></A><H3>
query</H3>
<PRE>
void <B>query</B>(<A HREF="../../../org/xmpp/component/Component.html" title="interface in org.xmpp.component">Component</A>&nbsp;component,
           <A HREF="../../../org/xmpp/packet/IQ.html" title="class in org.xmpp.packet">IQ</A>&nbsp;packet,
           <A HREF="../../../org/jivesoftware/openfire/IQResultListener.html" title="interface in org.jivesoftware.openfire">IQResultListener</A>&nbsp;listener)
           throws <A HREF="../../../org/xmpp/component/ComponentException.html" title="class in org.xmpp.component">ComponentException</A></PRE>
<DL>
<DD>Sends an IQ packet to the server and returns immediately. The specified IQResultListener
 will be invoked when an answer is received.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>component</CODE> - the component sending the packet.<DD><CODE>packet</CODE> - the IQ packet to send.<DD><CODE>listener</CODE> - the listener that will be invoked when an answer is received.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../org/xmpp/component/ComponentException.html" title="class in org.xmpp.component">ComponentException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="getProperty(java.lang.String)"><!-- --></A><H3>
getProperty</H3>
<PRE>
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getProperty</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name)</PRE>
<DL>
<DD>Returns a property value specified by name. Properties can be used by
 components to store configuration data. It is recommended that each
 component qualify property names to prevent overlap. For example a
 component that broadcasts messages to groups of users, might prepend
 all property names it uses with "broadcast.".
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the property name.
<DT><B>Returns:</B><DD>the property value.</DL>
</DD>
</DL>
<HR>

<A NAME="setProperty(java.lang.String, java.lang.String)"><!-- --></A><H3>
setProperty</H3>
<PRE>
void <B>setProperty</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name,
                 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;value)</PRE>
<DL>
<DD>Sets a property value. Properties can be used by components to
 store configuration data. It is recommended that each component
 qualify property names to prevent overlap. For example a component
 that broadcasts messages to groups of users, might prepend all
 property names it uses with "broadcast.".
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the property name.<DD><CODE>value</CODE> - the property value.</DL>
</DD>
</DL>
<HR>

<A NAME="getServerName()"><!-- --></A><H3>
getServerName</H3>
<PRE>
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getServerName</B>()</PRE>
<DL>
<DD>Returns the domain of the XMPP server. The domain name may be the IP address or the host
 name.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the domain of the XMPP server.</DL>
</DD>
</DL>
<HR>

<A NAME="isExternalMode()"><!-- --></A><H3>
isExternalMode</H3>
<PRE>
boolean <B>isExternalMode</B>()</PRE>
<DL>
<DD>Returns true if components managed by this component manager are external
 components connected to the server over a network connection. Otherwise,
 the components are internal to the server.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if the managed components are external components.</DL>
</DD>
</DL>
<HR>

<A NAME="getLog()"><!-- --></A><H3>
getLog</H3>
<PRE>
<A HREF="../../../org/xmpp/component/Log.html" title="interface in org.xmpp.component">Log</A> <B>getLog</B>()</PRE>
<DL>
<DD>Returns a Log instance, which can be used by components for logging error,
 warning, info, and debug messages.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a Log instance.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Openfire 3.6.0a Javadoc</b></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../org/xmpp/component/ComponentException.html" title="class in org.xmpp.component"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../org/xmpp/component/ComponentManagerFactory.html" title="class in org.xmpp.component"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html?org/xmpp/component/ComponentManager.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="ComponentManager.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
<i>Copyright &copy; 2003-2008 Jive Software.</i>
</BODY>
</HTML>