clearspacemanager.html

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

<A NAME="isEnabled()"><!-- --></A><H3>
isEnabled</H3>
<PRE>
public static boolean <B>isEnabled</B>()</PRE>
<DL>
<DD>Returns true if Clearspace is being used as the backend of Openfire. When
 integrated with Clearspace then users and groups will be pulled out from
 Clearspace. User authentication will also rely on Clearspace.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>true if Clearspace is being used as the backend of Openfire.</DL>
</DD>
</DL>
<HR>

<A NAME="start()"><!-- --></A><H3>
start</H3>
<PRE>
public void <B>start</B>()
           throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../org/jivesoftware/openfire/container/BasicModule.html#start()">BasicModule</A></CODE></B></DD>
<DD><p>Starts the basic module.</p>
 <p/>
 <p>Inheriting classes that choose to override this method MUST
 call this start() method before accessing BasicModule resources.</p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/container/Module.html#start()">start</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/container/Module.html" title="interface in org.jivesoftware.openfire.container">Module</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/container/BasicModule.html#start()">start</A></CODE> in class <CODE><A HREF="../../../../org/jivesoftware/openfire/container/BasicModule.html" title="class in org.jivesoftware.openfire.container">BasicModule</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></CODE> - If start is called before initialize
                               successfully returns</DL>
</DD>
</DL>
<HR>

<A NAME="stop()"><!-- --></A><H3>
stop</H3>
<PRE>
public void <B>stop</B>()</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../org/jivesoftware/openfire/container/BasicModule.html#stop()">BasicModule</A></CODE></B></DD>
<DD><p>Stops the basic module.</p>
 <p/>
 <p>Inheriting classes that choose to override this method MUST
 call this stop() method before accessing BasicModule resources.</p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/container/Module.html#stop()">stop</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/container/Module.html" title="interface in org.jivesoftware.openfire.container">Module</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/container/BasicModule.html#stop()">stop</A></CODE> in class <CODE><A HREF="../../../../org/jivesoftware/openfire/container/BasicModule.html" title="class in org.jivesoftware.openfire.container">BasicModule</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="configClearspace()"><!-- --></A><H3>
configClearspace</H3>
<PRE>
public boolean <B>configClearspace</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isClearspaceConfigured()"><!-- --></A><H3>
isClearspaceConfigured</H3>
<PRE>
public boolean <B>isClearspaceConfigured</B>()</PRE>
<DL>
<DD>Returns true if Clerspace was configured at least one time since Openfire startup.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>true if Clerspace was configured at least one time since Openfire startup.</DL>
</DD>
</DL>
<HR>

<A NAME="serviceEnabled(boolean)"><!-- --></A><H3>
serviceEnabled</H3>
<PRE>
public void <B>serviceEnabled</B>(boolean&nbsp;enabled)
                    throws <A HREF="../../../../org/jivesoftware/util/ModificationNotAllowedException.html" title="class in org.jivesoftware.util">ModificationNotAllowedException</A></PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/component/ExternalComponentManagerListener.html#serviceEnabled(boolean)">ExternalComponentManagerListener</A></CODE></B></DD>
<DD>Notification indicating whether the service is being enabled or disabled. The
 listener may throw an exception to not allow the change from taking place.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/component/ExternalComponentManagerListener.html#serviceEnabled(boolean)">serviceEnabled</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/component/ExternalComponentManagerListener.html" title="interface in org.jivesoftware.openfire.component">ExternalComponentManagerListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>enabled</CODE> - true if the service is being enabled.
<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="portChanged(int)"><!-- --></A><H3>
portChanged</H3>
<PRE>
public void <B>portChanged</B>(int&nbsp;newPort)
                 throws <A HREF="../../../../org/jivesoftware/util/ModificationNotAllowedException.html" title="class in org.jivesoftware.util">ModificationNotAllowedException</A></PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/component/ExternalComponentManagerListener.html#portChanged(int)">ExternalComponentManagerListener</A></CODE></B></DD>
<DD>Notification indicating that the port used by external components is being
 modified. The listener may throw an exception to not allow the change from
 taking place.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/component/ExternalComponentManagerListener.html#portChanged(int)">portChanged</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/component/ExternalComponentManagerListener.html" title="interface in org.jivesoftware.openfire.component">ExternalComponentManagerListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>newPort</CODE> - new default secret being set.
<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="defaultSecretChanged(java.lang.String)"><!-- --></A><H3>
defaultSecretChanged</H3>
<PRE>
public void <B>defaultSecretChanged</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;newSecret)
                          throws <A HREF="../../../../org/jivesoftware/util/ModificationNotAllowedException.html" title="class in org.jivesoftware.util">ModificationNotAllowedException</A></PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/component/ExternalComponentManagerListener.html#defaultSecretChanged(java.lang.String)">ExternalComponentManagerListener</A></CODE></B></DD>
<DD>Notification indicating that the default secret is being modified. The
 listener may throw an exception to not allow the change from taking place.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/component/ExternalComponentManagerListener.html#defaultSecretChanged(java.lang.String)">defaultSecretChanged</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/component/ExternalComponentManagerListener.html" title="interface in org.jivesoftware.openfire.component">ExternalComponentManagerListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>newSecret</CODE> - new default secret being set.
<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="permissionPolicyChanged(org.jivesoftware.openfire.component.ExternalComponentManager.PermissionPolicy)"><!-- --></A><H3>
permissionPolicyChanged</H3>
<PRE>
public void <B>permissionPolicyChanged</B>(<A HREF="../../../../org/jivesoftware/openfire/component/ExternalComponentManager.PermissionPolicy.html" title="enum in org.jivesoftware.openfire.component">ExternalComponentManager.PermissionPolicy</A>&nbsp;newPolicy)
                             throws <A HREF="../../../../org/jivesoftware/util/ModificationNotAllowedException.html" title="class in org.jivesoftware.util">ModificationNotAllowedException</A></PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/component/ExternalComponentManagerListener.html#permissionPolicyChanged(org.jivesoftware.openfire.component.ExternalComponentManager.PermissionPolicy)">ExternalComponentManagerListener</A></CODE></B></DD>
<DD>Notification indicating that the permission policy is being modified. See
 <A HREF="../../../../org/jivesoftware/openfire/component/ExternalComponentManager.PermissionPolicy.html" title="enum in org.jivesoftware.openfire.component"><CODE>ExternalComponentManager.PermissionPolicy</CODE></A> for more information. The
 listener may throw an exception to not allow the change from taking place.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/component/ExternalComponentManagerListener.html#permissionPolicyChanged(org.jivesoftware.openfire.component.ExternalComponentManager.PermissionPolicy)">permissionPolicyChanged</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/component/ExternalComponentManagerListener.html" title="interface in org.jivesoftware.openfire.component">ExternalComponentManagerListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>newPolicy</CODE> - new permission policy being set.
<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="componentAllowed(java.lang.String, org.jivesoftware.openfire.component.ExternalComponentConfiguration)"><!-- --></A><H3>
componentAllowed</H3>
<PRE>
public void <B>componentAllowed</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="../../../../org/jivesoftware/openfire/component/ExternalComponentConfiguration.html" title="class in org.jivesoftware.openfire.component">ExternalComponentConfiguration</A>&nbsp;configuration)
                      throws <A HREF="../../../../org/jivesoftware/util/ModificationNotAllowedException.html" title="class in org.jivesoftware.util">ModificationNotAllowedException</A></PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/component/ExternalComponentManagerListener.html#componentAllowed(java.lang.String, org.jivesoftware.openfire.component.ExternalComponentConfiguration)">ExternalComponentManagerListener</A></CODE></B></DD>
<DD>Notification indicating that a new component was allowed to connect using a
 given configuration. The listener may throw an exception to not allow the
 change from taking place.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/component/ExternalComponentManagerListener.html#componentAllowed(java.lang.String, org.jivesoftware.openfire.component.ExternalComponentConfiguration)">componentAllowed</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/component/ExternalComponentManagerListener.html" title="interface in org.jivesoftware.openfire.component">ExternalComponentManagerListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>subdomain</CODE> - subdomain of the added component.<DD><CODE>configuration</CODE> - configuration for 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="componentBlocked(java.lang.String)"><!-- --></A><H3>
componentBlocked</H3>
<PRE>
public void <B>componentBlocked</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><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/component/ExternalComponentManagerListener.html#componentBlocked(java.lang.String)">ExternalComponentManagerListener</A></CODE></B></DD>
<DD>Notification indicating that a component was blocked to connect to the server.
 The listener may throw an exception to not allow the change from taking place.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/component/ExternalComponentManagerListener.html#componentBlocked(java.lang.String)">componentBlocked</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/component/ExternalComponentManagerListener.html" title="interface in org.jivesoftware.openfire.component">ExternalComponentManagerListener</A></CODE