auditmanager.html

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

<DD><DL>
<DT><B>Parameters:</B><DD><CODE>logTimeout</CODE> - the time in milliseconds between successive executions of the task that will save
        the queued audited packets to a permanent store.</DL>
</DD>
</DL>
<HR>

<A NAME="getLogDir()"><!-- --></A><H3>
getLogDir</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>getLogDir</B>()</PRE>
<DL>
<DD>Returns the absolute path to the directory where the audit log files will be saved.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the absolute path to the directory where the audit log files will be saved.</DL>
</DD>
</DL>
<HR>

<A NAME="setLogDir(java.lang.String)"><!-- --></A><H3>
setLogDir</H3>
<PRE>
void <B>setLogDir</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;logDir)</PRE>
<DL>
<DD>Sets the absolute path to the directory where the audit log files will be saved.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>logDir</CODE> - the absolute path to the directory where the audit log files will be saved.</DL>
</DD>
</DL>
<HR>

<A NAME="isAuditMessage()"><!-- --></A><H3>
isAuditMessage</H3>
<PRE>
boolean <B>isAuditMessage</B>()</PRE>
<DL>
<DD><p>Determines if the server will audit all message packets.</p>
 <p>This is a speed optimization and convenience for logging all message packets
 rather than using an XPath expression.</p>
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if all messages are to be audited</DL>
</DD>
</DL>
<HR>

<A NAME="setAuditMessage(boolean)"><!-- --></A><H3>
setAuditMessage</H3>
<PRE>
void <B>setAuditMessage</B>(boolean&nbsp;enabled)</PRE>
<DL>
<DD><p>Enables or disables the server auditing of all message packets.</p>
 <p>This is a speed optimization and convenience for logging all message packets
 rather than using an XPath expression.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>enabled</CODE> - True if all messages are to be audited</DL>
</DD>
</DL>
<HR>

<A NAME="isAuditPresence()"><!-- --></A><H3>
isAuditPresence</H3>
<PRE>
boolean <B>isAuditPresence</B>()</PRE>
<DL>
<DD><p>Determines if the server will audit all presence packets.</p>
 <p>This is a speed optimization and convenience for logging all presence packets
 rather than using an XPath expression.</p>
<P>
<DD><DL>

<DT><B>Returns:</B><DD>True if all presence are to be audited</DL>
</DD>
</DL>
<HR>

<A NAME="setAuditPresence(boolean)"><!-- --></A><H3>
setAuditPresence</H3>
<PRE>
void <B>setAuditPresence</B>(boolean&nbsp;enabled)</PRE>
<DL>
<DD><p>Enables or disables the server auditing of all presence packets.</p>
 <p>This is a speed optimization and convenience for logging all presence packets
 rather than using an XPath expression.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>enabled</CODE> - True if all presence are to be audited</DL>
</DD>
</DL>
<HR>

<A NAME="isAuditIQ()"><!-- --></A><H3>
isAuditIQ</H3>
<PRE>
boolean <B>isAuditIQ</B>()</PRE>
<DL>
<DD><p>Determines if the server will audit all iq packets.</p>
 <p>This is a speed optimization and convenience for logging all iq packets
 rather than using an XPath expression.</p>
<P>
<DD><DL>

<DT><B>Returns:</B><DD>True if all iq are to be audited</DL>
</DD>
</DL>
<HR>

<A NAME="setAuditIQ(boolean)"><!-- --></A><H3>
setAuditIQ</H3>
<PRE>
void <B>setAuditIQ</B>(boolean&nbsp;enabled)</PRE>
<DL>
<DD>Enables or disables the server auditing of all iq packets.
 This is a speed optimization and convenience for logging all iq packets
 rather than using an XPath expression.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>enabled</CODE> - true if all iq are to be audited.</DL>
</DD>
</DL>
<HR>

<A NAME="isAuditXPath()"><!-- --></A><H3>
isAuditXPath</H3>
<PRE>
boolean <B>isAuditXPath</B>()</PRE>
<DL>
<DD>Determines if the server will audit packets using XPath expressions.
 XPath expressions provide a lot of power in specifying what is logged.
 However, it is much more compute intensive than other techniques and requires
 all packets be transformed into DOM objects (which can be computationally expensive).
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if XPath expressions should be audited.</DL>
</DD>
</DL>
<HR>

<A NAME="setAuditXPath(boolean)"><!-- --></A><H3>
setAuditXPath</H3>
<PRE>
void <B>setAuditXPath</B>(boolean&nbsp;enabled)</PRE>
<DL>
<DD><p>Enables/disables server auditing of packets using XPath expressions.</p>
 <p>XPath expressions provide a lot of power in specifying what is logged.
 However, it is much more compute intensive than other techniques and requires
 all packets be transformed into DOM objects (which can be computationally expensive).</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>enabled</CODE> - true if XPath expressions should be audited</DL>
</DD>
</DL>
<HR>

<A NAME="addXPath(java.lang.String)"><!-- --></A><H3>
addXPath</H3>
<PRE>
void <B>addXPath</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;xpathExpression)</PRE>
<DL>
<DD>Adds an XPath expression to be used for filtering packets to be audited.
 XPath expressions aren't evaluated or used for filtering unless isAuditXPath()
 returns true.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xpathExpression</CODE> - the xpath expression to add to the list of auditing filters.</DL>
</DD>
</DL>
<HR>

<A NAME="removeXPath(java.lang.String)"><!-- --></A><H3>
removeXPath</H3>
<PRE>
void <B>removeXPath</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;xpathExpression)</PRE>
<DL>
<DD><p>Removes the XPath expression from the set being used for filtering packets to be audited.</p>
 <p>XPath expressions aren't evaluated or used for filtering unless isAuditXPath()
 returns true.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xpathExpression</CODE> - The xpath expression to remove from the list of auditing filters</DL>
</DD>
</DL>
<HR>

<A NAME="getXPathFilters()"><!-- --></A><H3>
getXPathFilters</H3>
<PRE>
<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> <B>getXPathFilters</B>()</PRE>
<DL>
<DD><p>Obtain an iterator over the XPath expressions (Strings) currently registered
 with the audit manager.</p>
 <p>XPath expressions aren't evaluated or used for filtering unless isAuditXPath()
 returns true.</p>
<P>
<DD><DL>

<DT><B>Returns:</B><DD>An iterator of all XPath expressions the audit manager is using</DL>
</DD>
</DL>
<HR>

<A NAME="setIgnoreList(java.util.Collection)"><!-- --></A><H3>
setIgnoreList</H3>
<PRE>
void <B>setIgnoreList</B>(<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;&nbsp;usernames)</PRE>
<DL>
<DD>Sets the list of usernames that won't be audited. Packets sent or received by any of
 these users will be ignored by the auditor.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>usernames</CODE> - the list of usernames that won't be audited.</DL>
</DD>
</DL>
<HR>

<A NAME="getIgnoreList()"><!-- --></A><H3>
getIgnoreList</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="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>getIgnoreList</B>()</PRE>
<DL>
<DD>Returns the list of usernames that won't be audited. Packets sent or received by any of
 these users will be ignored by the auditor.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the list of usernames that won't be audited.</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/audit/AuditEvent.html" title="class in org.jivesoftware.openfire.audit"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/jivesoftware/openfire/audit/Auditor.html" title="interface in org.jivesoftware.openfire.audit"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/jivesoftware/openfire/audit/AuditManager.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="AuditManager.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;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&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>