lockoutprovider.html

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

<!-- ============ 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="getDisabledStatus(java.lang.String)"><!-- --></A><H3>
getDisabledStatus</H3>
<PRE>
<A HREF="../../../../org/jivesoftware/openfire/lockout/LockOutFlag.html" title="class in org.jivesoftware.openfire.lockout">LockOutFlag</A> <B>getDisabledStatus</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>Returns a LockOutFlag for a given username, which contains information about the time
 period that the specified account is going to be disabled or null if user can log in
 just fine.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>username</CODE> - Username of account to request status of.
<DT><B>Returns:</B><DD>The LockOutFlag instance describing the accounts disabled status or null if user
         account specified is not currently locked out (disabled).</DL>
</DD>
</DL>
<HR>

<A NAME="setDisabledStatus(org.jivesoftware.openfire.lockout.LockOutFlag)"><!-- --></A><H3>
setDisabledStatus</H3>
<PRE>
void <B>setDisabledStatus</B>(<A HREF="../../../../org/jivesoftware/openfire/lockout/LockOutFlag.html" title="class in org.jivesoftware.openfire.lockout">LockOutFlag</A>&nbsp;flag)</PRE>
<DL>
<DD>Sets the locked out (disabled) status of an account according to a LockOutFlag.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>flag</CODE> - A LockOutFlag instance to describe the disabled status of a user.</DL>
</DD>
</DL>
<HR>

<A NAME="unsetDisabledStatus(java.lang.String)"><!-- --></A><H3>
unsetDisabledStatus</H3>
<PRE>
void <B>unsetDisabledStatus</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>Unsets the locked out (disabled) status of an account, thereby enabling it/cancelling the disable.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>username</CODE> - User to enable.</DL>
</DD>
</DL>
<HR>

<A NAME="isReadOnly()"><!-- --></A><H3>
isReadOnly</H3>
<PRE>
boolean <B>isReadOnly</B>()</PRE>
<DL>
<DD>Returns true if this LockOutProvider is read-only. When read-only,
 disabled status of accounts can not be changed via Openfire.
<P>
<DD><DL>

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

<A NAME="isDelayedStartSupported()"><!-- --></A><H3>
isDelayedStartSupported</H3>
<PRE>
boolean <B>isDelayedStartSupported</B>()</PRE>
<DL>
<DD>Returns true if the LockOutProvider allows for a delayed start to the lockout.
 e.g. you can set the lockout to start in one hour.  This is really only used for UI
 in the admin interface.  It's up to the provider implementation to ignore the start
 time.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if the lock out provider provides this feature.</DL>
</DD>
</DL>
<HR>

<A NAME="isTimeoutSupported()"><!-- --></A><H3>
isTimeoutSupported</H3>
<PRE>
boolean <B>isTimeoutSupported</B>()</PRE>
<DL>
<DD>Returns true if the LockOutProvider allows for a timeout after which the lock out will expire.
 e.g. you can set the lockout to only last for one day.  This is really only used for UI
 in the admin interface.  It's up to the provider implementation to ignore the end
 time.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if the lcok out provider provides this feature.</DL>
</DD>
</DL>
<HR>

<A NAME="shouldNotBeCached()"><!-- --></A><H3>
shouldNotBeCached</H3>
<PRE>
boolean <B>shouldNotBeCached</B>()</PRE>
<DL>
<DD>Returns true if the lock out flags should not be cached, meaning every status lookup will
 go straight to the source.  This is typically set if the status can change on the provider
 target without Openfire knowing about it.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if disabled status should not be cached.</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/lockout/LockOutManager.html" title="class in org.jivesoftware.openfire.lockout"><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/lockout/LockOutProvider.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="LockOutProvider.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>