securityauditprovider.html

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

</TR>
</TABLE>

<A NAME="logEvent(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
logEvent</H3>
<PRE>
void <B>logEvent</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/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;summary,
              <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;details)</PRE>
<DL>
<DD>Records a security event in the audit logs.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>username</CODE> - Username of user who performed the security event.<DD><CODE>summary</CODE> - Short description of the event, similar to a subject.<DD><CODE>details</CODE> - Detailed description of the event, can be null if not desired.</DL>
</DD>
</DL>
<HR>

<A NAME="getEvents(java.lang.String, java.lang.Integer, java.lang.Integer, java.util.Date, java.util.Date)"><!-- --></A><H3>
getEvents</H3>
<PRE>
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A>&lt;<A HREF="../../../../org/jivesoftware/openfire/security/SecurityAuditEvent.html" title="class in org.jivesoftware.openfire.security">SecurityAuditEvent</A>&gt; <B>getEvents</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/lang/Integer.html" title="class or interface in java.lang">Integer</A>&nbsp;skipEvents,
                                   <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Integer.html" title="class or interface in java.lang">Integer</A>&nbsp;numEvents,
                                   <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;startTime,
                                   <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;endTime)</PRE>
<DL>
<DD>Retrieves security events that have occurred, filtered by the parameters passed.
 The events will be in order of most recent to least recent.  The provider is expected to
 create and fill out to the best of it's knowledge a list of SecurityAuditEvent objects.

 Any parameters that are left null are to be ignored.  In other words, if username is null,
 then no specific username is being searched for.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>username</CODE> - Username of user to look up.  Can be null for no username filtering.<DD><CODE>skipEvents</CODE> - Number of events to skip past (typically for paging).  Can be null for first page.<DD><CODE>numEvents</CODE> - Number of events to retrieve.  Can be null for "all" events.<DD><CODE>startTime</CODE> - Oldest date of range of events to retrieve.  Can be null for forever.<DD><CODE>endTime</CODE> - Most recent date of range of events to retrieve.  Can be null for "now".
<DT><B>Returns:</B><DD>Array of security events.</DL>
</DD>
</DL>
<HR>

<A NAME="getEvent(java.lang.Integer)"><!-- --></A><H3>
getEvent</H3>
<PRE>
<A HREF="../../../../org/jivesoftware/openfire/security/SecurityAuditEvent.html" title="class in org.jivesoftware.openfire.security">SecurityAuditEvent</A> <B>getEvent</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Integer.html" title="class or interface in java.lang">Integer</A>&nbsp;msgID)
                            throws <A HREF="../../../../org/jivesoftware/openfire/security/EventNotFoundException.html" title="class in org.jivesoftware.openfire.security">EventNotFoundException</A></PRE>
<DL>
<DD>Retrieves a specific event by ID.  The provider is expected to create and fill out to
 the best of it's knowledge a SecurityAuditEvent object.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>msgID</CODE> - ID number of event to retrieve.
<DT><B>Returns:</B><DD>SecurityAuditEvent object with information from retrieved event.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jivesoftware/openfire/security/EventNotFoundException.html" title="class in org.jivesoftware.openfire.security">EventNotFoundException</A></CODE> - if event was not found.</DL>
</DD>
</DL>
<HR>

<A NAME="getEventCount()"><!-- --></A><H3>
getEventCount</H3>
<PRE>
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Integer.html" title="class or interface in java.lang">Integer</A> <B>getEventCount</B>()</PRE>
<DL>
<DD>Retrieves number of events recorded.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>Number of events that have been recorded.</DL>
</DD>
</DL>
<HR>

<A NAME="isWriteOnly()"><!-- --></A><H3>
isWriteOnly</H3>
<PRE>
boolean <B>isWriteOnly</B>()</PRE>
<DL>
<DD>Returns true if the provider logs can be read by Openfire for display from Openfire's
 own admin interface.  If false, the administrative interface will place a stub in place
 to indicate that audit logs can not be read from this interface.  The provider can
 specify a URL that will be displayed on this stub to point at where the logs can
 be read.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>True or false if the logs can be read remotely.<DT><B>See Also:</B><DD><A HREF="../../../../org/jivesoftware/openfire/security/SecurityAuditProvider.html#getAuditURL()"><CODE>getAuditURL()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getAuditURL()"><!-- --></A><H3>
getAuditURL</H3>
<PRE>
<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>getAuditURL</B>()</PRE>
<DL>
<DD>Retrieves a URL that can be visited to read the logs audited by this provider.  This
 is typically used if you are referring to another interface that displays the audit
 logs via another applications own interface.  This is only useful if isWriteOnly is set
 to true.  You can safely return null to this if you don't need it, and also if you simply
 do not have a URL for an audit viewer interface.  The URL will only be referenced if it
 is not null.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>String represented URL that can be visited to view the audit logs.<DT><B>See Also:</B><DD><A HREF="../../../../org/jivesoftware/openfire/security/SecurityAuditProvider.html#isWriteOnly()"><CODE>isWriteOnly()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="blockUserEvents()"><!-- --></A><H3>
blockUserEvents</H3>
<PRE>
boolean <B>blockUserEvents</B>()</PRE>
<DL>
<DD>Returns true if the provider should not send user change (create, edit, delete, etc) related
 security events on through.  This is typically used if the service the provider is working
 with audits it's own user events and does not need Openfire to duplicate the event.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>True if we should block user related security audit events from being handled.</DL>
</DD>
</DL>
<HR>

<A NAME="blockGroupEvents()"><!-- --></A><H3>
blockGroupEvents</H3>
<PRE>
boolean <B>blockGroupEvents</B>()</PRE>
<DL>
<DD>Returns true if the provider should not send group change (create, edit, delete, etc) related
 security events on through.  This is typically used if the service the provider is working
 with audits it's own group events and does not need Openfire to duplicate the event.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>True if we should block group related security audit events from being handled.</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/security/SecurityAuditManager.html" title="class in org.jivesoftware.openfire.security"><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/security/SecurityAuditProvider.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="SecurityAuditProvider.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>