hybriduserprovider.html

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

<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>
public <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><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/user/UserProvider.html#findUsers(java.util.Set, java.lang.String, int, int)">UserProvider</A></CODE></B></DD>
<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>UserProvider.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>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/user/UserProvider.html#findUsers(java.util.Set, java.lang.String, int, int)">findUsers</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/user/UserProvider.html" title="interface in org.jivesoftware.openfire.user">UserProvider</A></CODE></DL>
</DD>
<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="getSearchFields()"><!-- --></A><H3>
getSearchFields</H3>
<PRE>
public <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><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/user/UserProvider.html#getSearchFields()">UserProvider</A></CODE></B></DD>
<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>UserProvider.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>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/user/UserProvider.html#getSearchFields()">getSearchFields</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/user/UserProvider.html" title="interface in org.jivesoftware.openfire.user">UserProvider</A></CODE></DL>
</DD>
<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="getUserCount()"><!-- --></A><H3>
getUserCount</H3>
<PRE>
public int <B>getUserCount</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/user/UserProvider.html#getUserCount()">UserProvider</A></CODE></B></DD>
<DD>Returns the number of users in the system.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/user/UserProvider.html#getUserCount()">getUserCount</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/user/UserProvider.html" title="interface in org.jivesoftware.openfire.user">UserProvider</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the total number of users.</DL>
</DD>
</DL>
<HR>

<A NAME="getUsernames()"><!-- --></A><H3>
getUsernames</H3>
<PRE>
public <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="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>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/user/UserProvider.html#getUsernames()">UserProvider</A></CODE></B></DD>
<DD>Returns an unmodifiable Collection of usernames of all users in the system.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/user/UserProvider.html#getUsernames()">getUsernames</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/user/UserProvider.html" title="interface in org.jivesoftware.openfire.user">UserProvider</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>an unmodifiable Collection of all usernames in the system.</DL>
</DD>
</DL>
<HR>

<A NAME="getUsers()"><!-- --></A><H3>
getUsers</H3>
<PRE>
public <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>getUsers</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/user/UserProvider.html#getUsers()">UserProvider</A></CODE></B></DD>
<DD>Returns an unmodifiable Collections of all users in the system. The
 <A HREF="../../../../org/jivesoftware/openfire/user/UserCollection.html" title="class in org.jivesoftware.openfire.user"><CODE>UserCollection</CODE></A> class can be used to assist in the implementation
 of this method. It takes a String [] of usernames and presents it as a
 Collection of User objects (obtained with calls to
 <A HREF="../../../../org/jivesoftware/openfire/user/UserManager.html#getUser(java.lang.String)"><CODE>UserManager.getUser(String)</CODE></A>.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/user/UserProvider.html#getUsers()">getUsers</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/user/UserProvider.html" title="interface in org.jivesoftware.openfire.user">UserProvider</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>an unmodifiable Collection of all users.</DL>
</DD>
</DL>
<HR>

<A NAME="getUsers(int, int)"><!-- --></A><H3>
getUsers</H3>
<PRE>
public <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>getUsers</B>(int&nbsp;startIndex,
                                 int&nbsp;numResults)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/user/UserProvider.html#getUsers(int, int)">UserProvider</A></CODE></B></DD>
<DD>Returns an unmodifiable Collections of users in the system within the
 specified range. The <A HREF="../../../../org/jivesoftware/openfire/user/UserCollection.html" title="class in org.jivesoftware.openfire.user"><CODE>UserCollection</CODE></A> class can be used to assist
 in the implementation of this method. It takes a String [] of usernames
 and presents it as a  Collection of User objects (obtained with calls to
 <A HREF="../../../../org/jivesoftware/openfire/user/UserManager.html#getUser(java.lang.String)"><CODE>UserManager.getUser(String)</CODE></A>.<p>

 It is possible that the number of results returned will be less than that
 specified by <tt>numResults</tt> if <tt>numResults</tt> is greater than the
 number of records left to display.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/user/UserProvider.html#getUsers(int, int)">getUsers</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/user/UserProvider.html" title="interface in org.jivesoftware.openfire.user">UserProvider</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>startIndex</CODE> - the beginning index to start the results at.<DD><CODE>numResults</CODE> - the total number of results to return.
<DT><B>Returns:</B><DD>an unmodifiable Collection of users within the specified range.</DL>
</DD>
</DL>
<HR>

<A NAME="isReadOnly()"><!-- --></A><H3>
isReadOnly</H3>
<PRE>
public boolean <B>isReadOnly</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/user/UserProvider.html#isReadOnly()">UserProvider</A></CODE></B></DD>
<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>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/user/UserProvider.html#isReadOnly()">isReadOnly</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/user/UserProvider.html" title="interface in org.jivesoftware.openfire.user">UserProvider</A></CODE></DL>
</DD>
<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>
public boolean <B>isNameRequired</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/user/UserProvider.html#isNameRequired()">UserProvider</A></CODE></B></DD>
<DD>Returns true if this UserProvider requires a name to be set on User objects.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/user/UserProvider.html#isNameRequired()">isNameRequired</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/user/UserProvider.html" title="interface in org.jivesoftware.openfire.user">UserProvider</A></CODE></DL>
</DD>
<DD><DL>

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