userprovider.html

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

                     throws <A HREF="../../../../org/jivesoftware/openfire/user/UserNotFoundException.html" title="class in org.jivesoftware.openfire.user">UserNotFoundException</A></PRE>
<DL>
<DD>Sets the date the user was created. This method should throw an
 UnsupportedOperationException if this operation is not supported
 by the backend user store.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>username</CODE> - the username.<DD><CODE>creationDate</CODE> - the date the user was created.
<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 the user could not be found.</DL>
</DD>
</DL>
<HR>

<A NAME="setModificationDate(java.lang.String, java.util.Date)"><!-- --></A><H3>
setModificationDate</H3>
<PRE>
void <B>setModificationDate</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/util/Date.html" title="class or interface in java.util">Date</A>&nbsp;modificationDate)
                         throws <A HREF="../../../../org/jivesoftware/openfire/user/UserNotFoundException.html" title="class in org.jivesoftware.openfire.user">UserNotFoundException</A></PRE>
<DL>
<DD>Sets the date the user was last modified. This method should throw an
 UnsupportedOperationException if this operation is not supported
 by the backend user store.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>username</CODE> - the username.<DD><CODE>modificationDate</CODE> - the date the user was last modified.
<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 the user could not be found.</DL>
</DD>
</DL>
<HR>

<A NAME="getSearchFields()"><!-- --></A><H3>
getSearchFields</H3>
<PRE>
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html" title="class or interface in java.util">Set</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>getSearchFields</B>()
                            throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang">UnsupportedOperationException</A></PRE>
<DL>
<DD>Returns the set of fields that can be used for searching for users. Each field
 returned must support wild-card and keyword searching. For example, an
 implementation might send back the set {"Username", "Name", "Email"}. Any of
 those three fields can then be used in a search with the
 <A HREF="../../../../org/jivesoftware/openfire/user/UserProvider.html#findUsers(java.util.Set, java.lang.String)"><CODE>findUsers(Set,String)</CODE></A> method.<p>

 This method should throw an UnsupportedOperationException if this
 operation is not supported by the backend user store.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the valid search fields.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - if the provider does not
      support the operation (this is an optional operation).</DL>
</DD>
</DL>
<HR>

<A NAME="findUsers(java.util.Set, java.lang.String)"><!-- --></A><H3>
findUsers</H3>
<PRE>
<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/user/User.html" title="class in org.jivesoftware.openfire.user">User</A>&gt; <B>findUsers</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html" title="class or interface in java.util">Set</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;&nbsp;fields,
                           <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;query)
                           throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang">UnsupportedOperationException</A></PRE>
<DL>
<DD>Searches for users based on a set of fields and a query string. The fields must
 be taken from the values returned by <A HREF="../../../../org/jivesoftware/openfire/user/UserProvider.html#getSearchFields()"><CODE>getSearchFields()</CODE></A>. The query can
 include wildcards. For example, a search on the field "Name" with a query of "Ma*"
 might return user's with the name "Matt", "Martha" and "Madeline".<p>

 This method should throw an UnsupportedOperationException if this
 operation is not supported by the backend user store.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fields</CODE> - the fields to search on.<DD><CODE>query</CODE> - the query string.
<DT><B>Returns:</B><DD>a Collection of users that match the search.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - if the provider does not
      support the operation (this is an optional operation).</DL>
</DD>
</DL>
<HR>

<A NAME="findUsers(java.util.Set, java.lang.String, int, int)"><!-- --></A><H3>
findUsers</H3>
<PRE>
<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/user/User.html" title="class in org.jivesoftware.openfire.user">User</A>&gt; <B>findUsers</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Set.html" title="class or interface in java.util">Set</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;&nbsp;fields,
                           <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;query,
                           int&nbsp;startIndex,
                           int&nbsp;numResults)
                           throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang">UnsupportedOperationException</A></PRE>
<DL>
<DD>Searches for users based on a set of fields and a query string. The fields must
 be taken from the values returned by <A HREF="../../../../org/jivesoftware/openfire/user/UserProvider.html#getSearchFields()"><CODE>getSearchFields()</CODE></A>. The query can
 include wildcards. For example, a search on the field "Name" with a query of "Ma*"
 might return user's with the name "Matt", "Martha" and "Madeline".<p>

 The startIndex and numResults parameters are used to page through search
 results. For example, if the startIndex is 0 and numResults is 10, the first
 10 search results will be returned. Note that numResults is a request for the
 number of results to return and that the actual number of results returned
 may be fewer.<p>

 This method should throw an UnsupportedOperationException if this
 operation is not supported by the backend user store.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fields</CODE> - the fields to search on.<DD><CODE>query</CODE> - the query string.<DD><CODE>startIndex</CODE> - the starting index in the search result to return.<DD><CODE>numResults</CODE> - the number of users to return in the search result.
<DT><B>Returns:</B><DD>a Collection of users that match the search.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - if the provider does not
      support the operation (this is an optional operation).</DL>
</DD>
</DL>
<HR>

<A NAME="isReadOnly()"><!-- --></A><H3>
isReadOnly</H3>
<PRE>
boolean <B>isReadOnly</B>()</PRE>
<DL>
<DD>Returns true if this UserProvider is read-only. When read-only,
 users can not be created, deleted, or modified.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if the user provider is read-only.</DL>
</DD>
</DL>
<HR>

<A NAME="isNameRequired()"><!-- --></A><H3>
isNameRequired</H3>
<PRE>
boolean <B>isNameRequired</B>()</PRE>
<DL>
<DD>Returns true if this UserProvider requires a name to be set on User objects.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if an name is required with this provider.</DL>
</DD>
</DL>
<HR>

<A NAME="isEmailRequired()"><!-- --></A><H3>
isEmailRequired</H3>
<PRE>
boolean <B>isEmailRequired</B>()</PRE>
<DL>
<DD>Returns true if this UserProvider requires an email address to be set on User objects.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if an email address is required with this provider.</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/user/UserNotFoundException.html" title="class in org.jivesoftware.openfire.user"><B>PREV CLASS</B></A>&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/jivesoftware/openfire/user/UserProvider.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="UserProvider.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;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&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>