externalcomponentmanager.html

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

<A NAME="getBlockedComponents()"><!-- --></A><H3>
getBlockedComponents</H3>
<PRE>
public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../../org/jivesoftware/openfire/component/ExternalComponentConfiguration.html" title="class in org.jivesoftware.openfire.component">ExternalComponentConfiguration</A>&gt; <B>getBlockedComponents</B>()</PRE>
<DL>
<DD>Returns the list of external components that are NOT allowed to connect to this
 server.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the configuration of the blocked external components.</DL>
</DD>
</DL>
<HR>

<A NAME="updateComponentSecret(java.lang.String, java.lang.String)"><!-- --></A><H3>
updateComponentSecret</H3>
<PRE>
public static void <B>updateComponentSecret</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,
                                         <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;secret)
                                  throws <A HREF="../../../../org/jivesoftware/util/ModificationNotAllowedException.html" title="class in org.jivesoftware.util">ModificationNotAllowedException</A></PRE>
<DL>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jivesoftware/util/ModificationNotAllowedException.html" title="class in org.jivesoftware.util">ModificationNotAllowedException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="deleteConfiguration(java.lang.String)"><!-- --></A><H3>
deleteConfiguration</H3>
<PRE>
public static void <B>deleteConfiguration</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/jivesoftware/util/ModificationNotAllowedException.html" title="class in org.jivesoftware.util">ModificationNotAllowedException</A></PRE>
<DL>
<DD>Removes any existing defined permission and configuration for the specified
 external component.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>subdomain</CODE> - the subdomain of the external component.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jivesoftware/util/ModificationNotAllowedException.html" title="class in org.jivesoftware.util">ModificationNotAllowedException</A></CODE> - if the operation was denied.</DL>
</DD>
</DL>
<HR>

<A NAME="getDefaultSecret()"><!-- --></A><H3>
getDefaultSecret</H3>
<PRE>
public static <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>getDefaultSecret</B>()</PRE>
<DL>
<DD>Returns the default secret key to use for those external components that don't have an
 individual configuration.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the default secret key to use for those external components that don't have an
         individual configuration.</DL>
</DD>
</DL>
<HR>

<A NAME="setDefaultSecret(java.lang.String)"><!-- --></A><H3>
setDefaultSecret</H3>
<PRE>
public static void <B>setDefaultSecret</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;defaultSecret)
                             throws <A HREF="../../../../org/jivesoftware/util/ModificationNotAllowedException.html" title="class in org.jivesoftware.util">ModificationNotAllowedException</A></PRE>
<DL>
<DD>Sets the default secret key to use for those external components that don't have an
 individual configuration.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>defaultSecret</CODE> - the default secret key to use for those external components that
         don't have an individual configuration.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jivesoftware/util/ModificationNotAllowedException.html" title="class in org.jivesoftware.util">ModificationNotAllowedException</A></CODE> - if the operation was denied.</DL>
</DD>
</DL>
<HR>

<A NAME="getSecretForComponent(java.lang.String)"><!-- --></A><H3>
getSecretForComponent</H3>
<PRE>
public static <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>getSecretForComponent</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)</PRE>
<DL>
<DD>Returns the shared secret with the specified external component. If no shared secret was
 defined then use the default shared secret.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>subdomain</CODE> - the subdomain of the external component to get his shared secret.
        (e.g. conference)
<DT><B>Returns:</B><DD>the shared secret with the specified external component or the default shared secret.</DL>
</DD>
</DL>
<HR>

<A NAME="getPermissionPolicy()"><!-- --></A><H3>
getPermissionPolicy</H3>
<PRE>
public static <A HREF="../../../../org/jivesoftware/openfire/component/ExternalComponentManager.PermissionPolicy.html" title="enum in org.jivesoftware.openfire.component">ExternalComponentManager.PermissionPolicy</A> <B>getPermissionPolicy</B>()</PRE>
<DL>
<DD>Returns the permission policy being used for new XMPP entities that are trying to
 connect to the server. There are two types of policies: 1) blacklist: where any entity
 is allowed to connect to the server except for those listed in the black list and
 2) whitelist: where only the entities listed in the white list are allowed to connect to
 the server.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the permission policy being used for new XMPP entities that are trying to
         connect to the server.</DL>
</DD>
</DL>
<HR>

<A NAME="setPermissionPolicy(org.jivesoftware.openfire.component.ExternalComponentManager.PermissionPolicy)"><!-- --></A><H3>
setPermissionPolicy</H3>
<PRE>
public static void <B>setPermissionPolicy</B>(<A HREF="../../../../org/jivesoftware/openfire/component/ExternalComponentManager.PermissionPolicy.html" title="enum in org.jivesoftware.openfire.component">ExternalComponentManager.PermissionPolicy</A>&nbsp;policy)
                                throws <A HREF="../../../../org/jivesoftware/util/ModificationNotAllowedException.html" title="class in org.jivesoftware.util">ModificationNotAllowedException</A></PRE>
<DL>
<DD>Sets the permission policy being used for new XMPP entities that are trying to
 connect to the server. There are two types of policies: 1) blacklist: where any entity
 is allowed to connect to the server except for those listed in the black list and
 2) whitelist: where only the entities listed in the white list are allowed to connect to
 the server.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>policy</CODE> - the new PermissionPolicy to use.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jivesoftware/util/ModificationNotAllowedException.html" title="class in org.jivesoftware.util">ModificationNotAllowedException</A></CODE> - if the operation was denied.</DL>
</DD>
</DL>
<HR>

<A NAME="setPermissionPolicy(java.lang.String)"><!-- --></A><H3>
setPermissionPolicy</H3>
<PRE>
public static void <B>setPermissionPolicy</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;policy)
                                throws <A HREF="../../../../org/jivesoftware/util/ModificationNotAllowedException.html" title="class in org.jivesoftware.util">ModificationNotAllowedException</A></PRE>
<DL>
<DD>Sets the permission policy being used for new XMPP entities that are trying to
 connect to the server. There are two types of policies: 1) blacklist: where any entity
 is allowed to connect to the server except for those listed in the black list and
 2) whitelist: where only the entities listed in the white list are allowed to connect to
 the server.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>policy</CODE> - the new policy to use.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jivesoftware/util/ModificationNotAllowedException.html" title="class in org.jivesoftware.util">ModificationNotAllowedException</A></CODE> - if the operation was denied.</DL>
</DD>
</DL>
<HR>

<A NAME="addListener(org.jivesoftware.openfire.component.ExternalComponentManagerListener)"><!-- --></A><H3>
addListener</H3>
<PRE>
public static void <B>addListener</B>(<A HREF="../../../../org/jivesoftware/openfire/component/ExternalComponentManagerListener.html" title="interface in org.jivesoftware.openfire.component">ExternalComponentManagerListener</A>&nbsp;listener)</PRE>
<DL>
<DD>Registers a listener to receive events when a configuration change happens. Listeners
 have the chance to deny the operation from happening.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>listener</CODE> - the listener.</DL>
</DD>
</DL>
<HR>

<A NAME="removeListener(org.jivesoftware.openfire.component.ExternalComponentManagerListener)"><!-- --></A><H3>
removeListener</H3>
<PRE>
public static void <B>removeListener</B>(<A HREF="../../../../org/jivesoftware/openfire/component/ExternalComponentManagerListener.html" title="interface in org.jivesoftware.openfire.component">ExternalComponentManagerListener</A>&nbsp;listener)</PRE>
<DL>
<DD>Unregisters a listener to receive events.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>listener</CODE> - the listener.</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/jivesoftware/openfire/component/ExternalComponentConfiguration.Permission.html" title="enum in org.jivesoftware.openfire.component"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/jivesoftware/openfire/component/ExternalComponentManager.PermissionPolicy.html" title="enum in org.jivesoftware.openfire.component"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/jivesoftware/openfire/component/ExternalComponentManager.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="ExternalComponentManager.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;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&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>