mucpersistencemanager.html

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

<DT><B>Parameters:</B><DD><CODE>room</CODE> - the room to load from the database if persistent</DL>
</DD>
</DL>
<HR>

<A NAME="saveToDB(org.jivesoftware.openfire.muc.spi.LocalMUCRoom)"><!-- --></A><H3>
saveToDB</H3>
<PRE>
public static void <B>saveToDB</B>(<A HREF="../../../../../org/jivesoftware/openfire/muc/spi/LocalMUCRoom.html" title="class in org.jivesoftware.openfire.muc.spi">LocalMUCRoom</A>&nbsp;room)</PRE>
<DL>
<DD>Save the room configuration to the DB.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>room</CODE> - The room to save its configuration.</DL>
</DD>
</DL>
<HR>

<A NAME="deleteFromDB(org.jivesoftware.openfire.muc.MUCRoom)"><!-- --></A><H3>
deleteFromDB</H3>
<PRE>
public static void <B>deleteFromDB</B>(<A HREF="../../../../../org/jivesoftware/openfire/muc/MUCRoom.html" title="interface in org.jivesoftware.openfire.muc">MUCRoom</A>&nbsp;room)</PRE>
<DL>
<DD>Removes the room configuration and its affiliates from the database.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>room</CODE> - the room to remove from the database.</DL>
</DD>
</DL>
<HR>

<A NAME="loadRoomsFromDB(org.jivesoftware.openfire.muc.MultiUserChatService, java.util.Date, org.jivesoftware.openfire.PacketRouter)"><!-- --></A><H3>
loadRoomsFromDB</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/muc/spi/LocalMUCRoom.html" title="class in org.jivesoftware.openfire.muc.spi">LocalMUCRoom</A>&gt; <B>loadRoomsFromDB</B>(<A HREF="../../../../../org/jivesoftware/openfire/muc/MultiUserChatService.html" title="interface in org.jivesoftware.openfire.muc">MultiUserChatService</A>&nbsp;chatserver,
                                                       <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Date.html" title="class or interface in java.util">Date</A>&nbsp;emptyDate,
                                                       <A HREF="../../../../../org/jivesoftware/openfire/PacketRouter.html" title="interface in org.jivesoftware.openfire">PacketRouter</A>&nbsp;packetRouter)</PRE>
<DL>
<DD>Loads all the rooms that had occupants after a given date from the database. This query
 will be executed only when the service is starting up.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>chatserver</CODE> - the chat server that will hold the loaded rooms.<DD><CODE>emptyDate</CODE> - rooms that hadn't been used before this date won't be loaded.<DD><CODE>packetRouter</CODE> - the PacketRouter that loaded rooms will use to send packets.
<DT><B>Returns:</B><DD>a collection with all the persistent rooms.</DL>
</DD>
</DL>
<HR>

<A NAME="updateRoomSubject(org.jivesoftware.openfire.muc.MUCRoom)"><!-- --></A><H3>
updateRoomSubject</H3>
<PRE>
public static void <B>updateRoomSubject</B>(<A HREF="../../../../../org/jivesoftware/openfire/muc/MUCRoom.html" title="interface in org.jivesoftware.openfire.muc">MUCRoom</A>&nbsp;room)</PRE>
<DL>
<DD>Updates the room's subject in the database.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>room</CODE> - the room to update its subject in the database.</DL>
</DD>
</DL>
<HR>

<A NAME="updateRoomLock(org.jivesoftware.openfire.muc.spi.LocalMUCRoom)"><!-- --></A><H3>
updateRoomLock</H3>
<PRE>
public static void <B>updateRoomLock</B>(<A HREF="../../../../../org/jivesoftware/openfire/muc/spi/LocalMUCRoom.html" title="class in org.jivesoftware.openfire.muc.spi">LocalMUCRoom</A>&nbsp;room)</PRE>
<DL>
<DD>Updates the room's lock status in the database.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>room</CODE> - the room to update its lock status in the database.</DL>
</DD>
</DL>
<HR>

<A NAME="updateRoomEmptyDate(org.jivesoftware.openfire.muc.MUCRoom)"><!-- --></A><H3>
updateRoomEmptyDate</H3>
<PRE>
public static void <B>updateRoomEmptyDate</B>(<A HREF="../../../../../org/jivesoftware/openfire/muc/MUCRoom.html" title="interface in org.jivesoftware.openfire.muc">MUCRoom</A>&nbsp;room)</PRE>
<DL>
<DD>Updates the room's lock status in the database.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>room</CODE> - the room to update its lock status in the database.</DL>
</DD>
</DL>
<HR>

<A NAME="saveAffiliationToDB(org.jivesoftware.openfire.muc.MUCRoom, java.lang.String, java.lang.String, org.jivesoftware.openfire.muc.MUCRole.Affiliation, org.jivesoftware.openfire.muc.MUCRole.Affiliation)"><!-- --></A><H3>
saveAffiliationToDB</H3>
<PRE>
public static void <B>saveAffiliationToDB</B>(<A HREF="../../../../../org/jivesoftware/openfire/muc/MUCRoom.html" title="interface in org.jivesoftware.openfire.muc">MUCRoom</A>&nbsp;room,
                                       <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;bareJID,
                                       <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;nickname,
                                       <A HREF="../../../../../org/jivesoftware/openfire/muc/MUCRole.Affiliation.html" title="enum in org.jivesoftware.openfire.muc">MUCRole.Affiliation</A>&nbsp;newAffiliation,
                                       <A HREF="../../../../../org/jivesoftware/openfire/muc/MUCRole.Affiliation.html" title="enum in org.jivesoftware.openfire.muc">MUCRole.Affiliation</A>&nbsp;oldAffiliation)</PRE>
<DL>
<DD>Update the DB with the new affiliation of the user in the room. The new information will be
 saved only if the room is_persistent and has already been saved to the database previously.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>room</CODE> - The room where the affiliation of the user was updated.<DD><CODE>bareJID</CODE> - The bareJID of the user to update this affiliation.<DD><CODE>nickname</CODE> - The reserved nickname of the user in the room or null if none.<DD><CODE>newAffiliation</CODE> - the new affiliation of the user in the room.<DD><CODE>oldAffiliation</CODE> - the previous affiliation of the user in the room.</DL>
</DD>
</DL>
<HR>

<A NAME="removeAffiliationFromDB(org.jivesoftware.openfire.muc.MUCRoom, java.lang.String, org.jivesoftware.openfire.muc.MUCRole.Affiliation)"><!-- --></A><H3>
removeAffiliationFromDB</H3>
<PRE>
public static void <B>removeAffiliationFromDB</B>(<A HREF="../../../../../org/jivesoftware/openfire/muc/MUCRoom.html" title="interface in org.jivesoftware.openfire.muc">MUCRoom</A>&nbsp;room,
                                           <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;bareJID,
                                           <A HREF="../../../../../org/jivesoftware/openfire/muc/MUCRole.Affiliation.html" title="enum in org.jivesoftware.openfire.muc">MUCRole.Affiliation</A>&nbsp;oldAffiliation)</PRE>
<DL>
<DD>Removes the affiliation of the user from the DB if the room is persistent.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>room</CODE> - The room where the affiliation of the user was removed.<DD><CODE>bareJID</CODE> - The bareJID of the user to remove his affiliation.<DD><CODE>oldAffiliation</CODE> - the previous affiliation of the user in the room.</DL>
</DD>
</DL>
<HR>

<A NAME="removeAffiliationFromDB(org.xmpp.packet.JID)"><!-- --></A><H3>
removeAffiliationFromDB</H3>
<PRE>
public static void <B>removeAffiliationFromDB</B>(<A HREF="../../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;bareJID)</PRE>
<DL>
<DD>Removes the affiliation of the user from the DB if ANY room that is persistent.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>bareJID</CODE> - The bareJID of the user to remove his affiliation from ALL persistent rooms.</DL>
</DD>
</DL>
<HR>

<A NAME="saveConversationLogEntry(org.jivesoftware.openfire.muc.spi.ConversationLogEntry)"><!-- --></A><H3>
saveConversationLogEntry</H3>
<PRE>
public static boolean <B>saveConversationLogEntry</B>(org.jivesoftware.openfire.muc.spi.ConversationLogEntry&nbsp;entry)</PRE>
<DL>
<DD>Saves the conversation log entry to the database.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>entry</CODE> - the ConversationLogEntry to save to the database.
<DT><B>Returns:</B><DD>true if the ConversationLogEntry was saved successfully to the database.</DL>
</DD>
</DL>
<HR>

<A NAME="getProperty(java.lang.String, java.lang.String)"><!-- --></A><H3>
getProperty</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>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;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;name)</PRE>
<DL>
<DD>Returns a Jive property.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>subdomain</CODE> - the subdomain of the service to retrieve a property from<DD><CODE>name</CODE> - the name of the property to return.
<DT><B>Returns:</B><DD>the property value specified by name.</DL>
</DD>
</DL>
<HR>

<A NAME="getProperty(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
getProperty</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>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;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;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;defaultValue)</PRE>
<DL>
<DD>Returns a Jive property. If the specified property doesn't exist, the
 <tt>defaultValue</tt> will be returned.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>subdomain</CODE> - the subdomain of the service to retrieve a property from<DD><CODE>name</CODE> - the name of the property to return.<DD><CODE>defaultValue</CODE> - value returned if the property doesn't exist.
<DT><B>Returns:</B><DD>the property value specified by name.</DL>
</DD>
</DL>
<HR>

<A NAME="getIntProperty(java.lang.String, java.lang.String, int)"><!-- --></A><H3>
getIntProperty</H3>
<PRE>
public static int <B>getIntProperty</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;name,
                                 int&nbsp;defaultValue)</PRE>
<DL>
<DD>Returns an integer value Jive property. If the specified property doesn't exist, the
 <tt>defaultValue</tt> will be returned.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>subdomain</CODE> - the subdomain of the service to retrieve a property from<DD><CODE>name</CODE> - the name of the property to return.<DD><CODE>defaultValue</CODE> - value returned if the property doesn't exist or was not
      a number.
<DT><B>Returns:</B><DD>the property value specified by name or <tt>defaultValue</tt>.</DL>
</DD>
</DL>
<HR>

<A NAME="getLongProperty(java.lang.String, java.lang.String, long)"><!-- --></A><H3>
getLongProperty</H3>
<PRE>
public static long <B>getLongProperty</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;name,
                                   long&nbsp;defaultValue)</PRE>
<DL>
<DD>Returns a long value Jive property. If the specified property doesn't exist, the
 <tt>defaultValue</tt> will be returned.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>subdomain</CODE> - the subdomain of the service to retrieve a property from<DD><CODE>name</CODE> - the name of the property to return.<DD><CODE>defaultValue</CODE> - value returned if the property doesn't exist or was not
      a number.
<DT><B>Returns:</B><DD>the property value specified by name or <tt>defaultValue</tt>.</DL>
</DD>
</DL>
<HR>

<A NAME="getBooleanProperty(java.lang.String, java.lang.String)"><!-- --></A><H3>
getBooleanProperty</H3>
<PRE>
public static boolean <B>getBooleanProperty</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;name)</PRE>
<DL>
<DD>Returns a boolean value Jive property.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>subdomain</CODE> - the subdomain of the service to retrieve a property from<DD><CODE>name</CODE> - the name of the property to return.