rosteritemprovider.html

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

 
<P>

<!-- ========= 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="RosterItemProvider()"><!-- --></A><H3>
RosterItemProvider</H3>
<PRE>
public <B>RosterItemProvider</B>()</PRE>
<DL>
</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/roster/RosterItemProvider.html" title="class in org.jivesoftware.openfire.roster">RosterItemProvider</A> <B>getInstance</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="createItem(java.lang.String, org.jivesoftware.openfire.roster.RosterItem)"><!-- --></A><H3>
createItem</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.html" title="class in org.jivesoftware.openfire.roster">RosterItem</A> <B>createItem</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="../../../../org/jivesoftware/openfire/roster/RosterItem.html" title="class in org.jivesoftware.openfire.roster">RosterItem</A>&nbsp;item)
                      throws <A HREF="../../../../org/jivesoftware/openfire/user/UserAlreadyExistsException.html" title="class in org.jivesoftware.openfire.user">UserAlreadyExistsException</A></PRE>
<DL>
<DD>Creates a new roster item for the given user (optional operation).<p>

 <b>Important!</b> The item passed as a parameter to this method is strictly a convenience
 for passing all of the data needed for a new roster item. The roster item returned from the
 method will be cached by Openfire. In some cases, the roster item passed in will be passed
 back out. However, if an implementation may return RosterItems as a separate class
 (for example, a RosterItem that directly accesses the backend storage, or one that is an
 object in an object database).<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>username</CODE> - the username of the user/chatbot that owns the roster item.<DD><CODE>item</CODE> - the settings for the roster item to create.
<DT><B>Returns:</B><DD>the new roster item.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jivesoftware/openfire/user/UserAlreadyExistsException.html" title="class in org.jivesoftware.openfire.user">UserAlreadyExistsException</A></CODE> - if a roster item with the username already exists.</DL>
</DD>
</DL>
<HR>

<A NAME="updateItem(java.lang.String, org.jivesoftware.openfire.roster.RosterItem)"><!-- --></A><H3>
updateItem</H3>
<PRE>
public void <B>updateItem</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="../../../../org/jivesoftware/openfire/roster/RosterItem.html" title="class in org.jivesoftware.openfire.roster">RosterItem</A>&nbsp;item)
                throws <A HREF="../../../../org/jivesoftware/openfire/user/UserNotFoundException.html" title="class in org.jivesoftware.openfire.user">UserNotFoundException</A></PRE>
<DL>
<DD>Update the roster item in storage with the information contained in the given item
 (optional operation).<p>

 If you don't want roster items edited through openfire, throw UnsupportedOperationException.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>username</CODE> - the username of the user/chatbot that owns the roster item<DD><CODE>item</CODE> - The roster item to update
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jivesoftware/openfire/user/UserNotFoundException.html" title="class in org.jivesoftware.openfire.user">UserNotFoundException</A></CODE> - If no entry could be found to update</DL>
</DD>
</DL>
<HR>

<A NAME="deleteItem(java.lang.String, long)"><!-- --></A><H3>
deleteItem</H3>
<PRE>
public void <B>deleteItem</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,
                       long&nbsp;rosterItemID)</PRE>
<DL>
<DD>Delete the roster item with the given itemJID for the user (optional operation).<p>

 If you don't want roster items deleted through openfire, throw
 UnsupportedOperationException.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>username</CODE> - the long ID of the user/chatbot that owns the roster item<DD><CODE>rosterItemID</CODE> - The roster item to delete</DL>
</DD>
</DL>
<HR>

<A NAME="getUsernames(java.lang.String)"><!-- --></A><H3>
getUsernames</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html" title="class or interface in java.util">Iterator</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>&gt; <B>getUsernames</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;jid)</PRE>
<DL>
<DD>Returns an iterator on the usernames whose roster includes the specified JID.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>jid</CODE> - the jid that the rosters should include.
<DT><B>Returns:</B><DD>an iterator on the usernames whose roster includes the specified JID.</DL>
</DD>
</DL>
<HR>

<A NAME="getItemCount(java.lang.String)"><!-- --></A><H3>
getItemCount</H3>
<PRE>
public int <B>getItemCount</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)</PRE>
<DL>
<DD>Obtain a count of the number of roster items available for the given user.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>username</CODE> - the username of the user/chatbot that owns the roster items
<DT><B>Returns:</B><DD>The number of roster items available for the user</DL>
</DD>
</DL>
<HR>

<A NAME="getItems(java.lang.String)"><!-- --></A><H3>
getItems</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html" title="class or interface in java.util">Iterator</A>&lt;<A HREF="../../../../org/jivesoftware/openfire/roster/RosterItem.html" title="class in org.jivesoftware.openfire.roster">RosterItem</A>&gt; <B>getItems</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)</PRE>
<DL>
<DD>Retrieve an iterator of RosterItems for the given user.<p>

 This method will commonly be called when a user logs in. The data will be cached
 in memory when possible. However, some rosters may be very large so items may need
 to be retrieved from the provider more frequently than usual for provider data.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>username</CODE> - the username of the user/chatbot that owns the roster items
<DT><B>Returns:</B><DD>An iterator of all RosterItems owned by the user</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/roster/RosterItem.SubType.html" title="class in org.jivesoftware.openfire.roster"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/jivesoftware/openfire/roster/RosterManager.html" title="class in org.jivesoftware.openfire.roster"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/jivesoftware/openfire/roster/RosterItemProvider.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="RosterItemProvider.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;<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>