clearspacemanager.html

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

</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="ClearspaceManager(java.util.Map)"><!-- --></A><H3>
ClearspaceManager</H3>
<PRE>
public <B>ClearspaceManager</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&lt;<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>,<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>&gt;&nbsp;properties)</PRE>
<DL>
<DD>Constructs a new ClearspaceManager instance. Typically, <A HREF="../../../../org/jivesoftware/openfire/clearspace/ClearspaceManager.html#getInstance()"><CODE>getInstance()</CODE></A> should be
 called instead of this method. ClearspaceManager instances should only be created directly
 for testing purposes.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>properties</CODE> - the Map that contains properties used by the Clearspace manager, such as
                   Clearspace host and shared secret.</DL>
</DL>
<HR>

<A NAME="ClearspaceManager()"><!-- --></A><H3>
ClearspaceManager</H3>
<PRE>
public <B>ClearspaceManager</B>()</PRE>
<DL>
<DD>Constructs a new ClearspaceManager instance. Typically, <A HREF="../../../../org/jivesoftware/openfire/clearspace/ClearspaceManager.html#getInstance()"><CODE>getInstance()</CODE></A> should be
 called instead of this method. ClearspaceManager instances should only be created directly
 for testing purposes.
<P>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="getInstance()"><!-- --></A><H3>
getInstance</H3>
<PRE>
public static <A HREF="../../../../org/jivesoftware/openfire/clearspace/ClearspaceManager.html" title="class in org.jivesoftware.openfire.clearspace">ClearspaceManager</A> <B>getInstance</B>()</PRE>
<DL>
<DD>Provides singleton access to an instance of the ClearspaceManager class.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>an ClearspaceManager instance.</DL>
</DD>
</DL>
<HR>

<A NAME="checkAuthentication(java.lang.String, java.lang.String)"><!-- --></A><H3>
checkAuthentication</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Boolean.html" title="class or interface in java.lang">Boolean</A> <B>checkAuthentication</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;username,
                                   <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;password)</PRE>
<DL>
<DD>Check a username/password pair for valid authentication.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>username</CODE> - Username to authenticate against.<DD><CODE>password</CODE> - Password to use for authentication.
<DT><B>Returns:</B><DD>True or false of the authentication succeeded.</DL>
</DD>
</DL>
<HR>

<A NAME="testConnection()"><!-- --></A><H3>
testConnection</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Throwable.html" title="class or interface in java.lang">Throwable</A> <B>testConnection</B>()</PRE>
<DL>
<DD>Tests the web services connection with Clearspace given the manager's current configuration.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The exception or unll if connection test was successful.</DL>
</DD>
</DL>
<HR>

<A NAME="isOpenfireConnected()"><!-- --></A><H3>
isOpenfireConnected</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Boolean.html" title="class or interface in java.lang">Boolean</A> <B>isOpenfireConnected</B>()</PRE>
<DL>
<DD>Returns true if Openfire is connected to Clearspace.
 This method may delay some time since it has to ping Clearspace to know if
 Openfire is able to connect to it.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>true if Openfire is connected to Clearspace.</DL>
</DD>
</DL>
<HR>

<A NAME="isClearspaceConnected()"><!-- --></A><H3>
isClearspaceConnected</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Boolean.html" title="class or interface in java.lang">Boolean</A> <B>isClearspaceConnected</B>()</PRE>
<DL>
<DD>Returns true if Clearspce is connected to Openfire.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>true if Clearspce is connected to Openfire.</DL>
</DD>
</DL>
<HR>

<A NAME="getProperties()"><!-- --></A><H3>
getProperties</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&lt;<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>,<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>&gt; <B>getProperties</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getConnectionURI()"><!-- --></A><H3>
getConnectionURI</H3>
<PRE>
public <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>getConnectionURI</B>()</PRE>
<DL>
<DD>Returns the Clearspace service URI; e.g. <tt>https://localhost:80/clearspace</tt>.
 This value is stored as the Jive Property <tt>clearspace.uri</tt>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the Clearspace service URI.</DL>
</DD>
</DL>
<HR>

<A NAME="setConnectionURI(java.lang.String)"><!-- --></A><H3>
setConnectionURI</H3>
<PRE>
public void <B>setConnectionURI</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;uri)</PRE>
<DL>
<DD>Sets the URI of the Clearspace service; e.g., <tt>https://localhost:80/clearspace</tt>.
 This value is stored as the Jive Property <tt>clearspace.uri</tt>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>uri</CODE> - the Clearspace service URI.</DL>
</DD>
</DL>
<HR>

<A NAME="getSharedSecret()"><!-- --></A><H3>
getSharedSecret</H3>
<PRE>
public <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>getSharedSecret</B>()</PRE>
<DL>
<DD>Returns the password, configured in Clearspace, that Openfire will use to authenticate
 with Clearspace to perform it's integration.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the password Openfire will use to authenticate with Clearspace.</DL>
</DD>
</DL>
<HR>

<A NAME="setSharedSecret(java.lang.String)"><!-- --></A><H3>
setSharedSecret</H3>
<PRE>
public void <B>setSharedSecret</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;sharedSecret)</PRE>
<DL>
<DD>Sets the shared secret for the Clearspace service we're connecting to.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sharedSecret</CODE> - the password configured in Clearspace to authenticate Openfire.</DL>
</DD>
</DL>
<HR>