📄 auditmanager.html
字号:
<TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/audit/AuditManager.html#setAuditMessage(boolean)">setAuditMessage</A></B>(boolean enabled)</CODE><BR> Enables or disables the server auditing of all message packets.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/audit/AuditManager.html#setAuditPresence(boolean)">setAuditPresence</A></B>(boolean enabled)</CODE><BR> Enables or disables the server auditing of all presence packets.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/audit/AuditManager.html#setAuditXPath(boolean)">setAuditXPath</A></B>(boolean enabled)</CODE><BR> Enables/disables server auditing of packets using XPath expressions.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/audit/AuditManager.html#setEnabled(boolean)">setEnabled</A></B>(boolean enabled)</CODE><BR> Turns auditing off or on for the manager as a whole.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/audit/AuditManager.html#setIgnoreList(java.util.Collection)">setIgnoreList</A></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><<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>> usernames)</CODE><BR> Sets the list of usernames that won't be audited.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/audit/AuditManager.html#setLogDir(java.lang.String)">setLogDir</A></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> logDir)</CODE><BR> Sets the absolute path to the directory where the audit log files will be saved.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/audit/AuditManager.html#setLogTimeout(int)">setLogTimeout</A></B>(int logTimeout)</CODE><BR> Sets the time in milliseconds between successive executions of the task that will save the queued audited packets to a permanent store.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/audit/AuditManager.html#setMaxDays(int)">setMaxDays</A></B>(int count)</CODE><BR> Set the the maximum number of days to keep audit information.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/audit/AuditManager.html#setMaxFileSize(int)">setMaxFileSize</A></B>(int size)</CODE><BR> Set the maximum size of audit log files in megabytes.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../org/jivesoftware/openfire/audit/AuditManager.html#setMaxTotalSize(int)">setMaxTotalSize</A></B>(int size)</CODE><BR> Sets the maximum size in megabytes that all audit log files may have.</TD></TR></TABLE> <P><!-- ============ FIELD DETAIL =========== --><A NAME="field_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>Field Detail</B></FONT></TH></TR></TABLE><A NAME="PRESENCE_UNAVAILABLE_AVAILABLE"><!-- --></A><H3>PRESENCE_UNAVAILABLE_AVAILABLE</H3><PRE>static final int <B>PRESENCE_UNAVAILABLE_AVAILABLE</B></PRE><DL><DL><DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.jivesoftware.openfire.audit.AuditManager.PRESENCE_UNAVAILABLE_AVAILABLE">Constant Field Values</A></DL></DL><HR><A NAME="PRESENCE_AVAILABLE_AVAILABLE"><!-- --></A><H3>PRESENCE_AVAILABLE_AVAILABLE</H3><PRE>static final int <B>PRESENCE_AVAILABLE_AVAILABLE</B></PRE><DL><DL><DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.jivesoftware.openfire.audit.AuditManager.PRESENCE_AVAILABLE_AVAILABLE">Constant Field Values</A></DL></DL><HR><A NAME="PRESENCE_AVAILABLE_UNAVAILABLE"><!-- --></A><H3>PRESENCE_AVAILABLE_UNAVAILABLE</H3><PRE>static final int <B>PRESENCE_AVAILABLE_UNAVAILABLE</B></PRE><DL><DL><DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.jivesoftware.openfire.audit.AuditManager.PRESENCE_AVAILABLE_UNAVAILABLE">Constant Field Values</A></DL></DL><HR><A NAME="PRESENCE_UNAVAILABLE_UNAVAILABLE"><!-- --></A><H3>PRESENCE_UNAVAILABLE_UNAVAILABLE</H3><PRE>static final int <B>PRESENCE_UNAVAILABLE_UNAVAILABLE</B></PRE><DL><DL><DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.jivesoftware.openfire.audit.AuditManager.PRESENCE_UNAVAILABLE_UNAVAILABLE">Constant Field Values</A></DL></DL><!-- ============ 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="isEnabled()"><!-- --></A><H3>isEnabled</H3><PRE>boolean <B>isEnabled</B>()</PRE><DL><DD>Determines if auditing is enabled at all.<P><DD><DL><DT><B>Returns:</B><DD>true if auditing is enabled, false indicates no auditing will occur</DL></DD></DL><HR><A NAME="setEnabled(boolean)"><!-- --></A><H3>setEnabled</H3><PRE>void <B>setEnabled</B>(boolean enabled)</PRE><DL><DD>Turns auditing off or on for the manager as a whole.<P><DD><DL><DT><B>Parameters:</B><DD><CODE>enabled</CODE> - true if auditing is enabled, false indicates no auditing will occur.</DL></DD></DL><HR><A NAME="getAuditor()"><!-- --></A><H3>getAuditor</H3><PRE><A HREF="../../../../org/jivesoftware/openfire/audit/Auditor.html" title="interface in org.jivesoftware.openfire.audit">Auditor</A> <B>getAuditor</B>()</PRE><DL><DD>Factory method for creating auditors that are configured by this audit manager.<P><DD><DL><DT><B>Returns:</B><DD>a new auditor that will obey the configuration of the audit manager.</DL></DD></DL><HR><A NAME="getMaxTotalSize()"><!-- --></A><H3>getMaxTotalSize</H3><PRE>int <B>getMaxTotalSize</B>()</PRE><DL><DD>Returns the maximum size in megabytes that all audit log files may have. When the limit is reached oldest audit log files will be removed until total size is under the limit.<P><DD><DL><DT><B>Returns:</B><DD>the maximum size of all audit logs in megabytes.</DL></DD></DL><HR><A NAME="setMaxTotalSize(int)"><!-- --></A><H3>setMaxTotalSize</H3><PRE>void <B>setMaxTotalSize</B>(int size)</PRE><DL><DD>Sets the maximum size in megabytes that all audit log files may have. When the limit is reached oldest audit log files will be removed until total size is under the limit.<P><DD><DL><DT><B>Parameters:</B><DD><CODE>size</CODE> - the maximum size of all audit logs in megabytes.</DL></DD></DL><HR><A NAME="getMaxFileSize()"><!-- --></A><H3>getMaxFileSize</H3><PRE>int <B>getMaxFileSize</B>()</PRE><DL><DD>Obtain the maximum size of audit log files in megabytes. Logs that exceed the max size will be rolled over to another file.<P><DD><DL><DT><B>Returns:</B><DD>the maximum size of an audit log in megabytes.</DL></DD></DL><HR><A NAME="setMaxFileSize(int)"><!-- --></A><H3>setMaxFileSize</H3><PRE>void <B>setMaxFileSize</B>(int size)</PRE><DL><DD>Set the maximum size of audit log files in megabytes.<P><DD><DL><DT><B>Parameters:</B><DD><CODE>size</CODE> - the maximum audit log file size in megabytes.</DL></DD></DL><HR><A NAME="getMaxDays()"><!-- --></A><H3>getMaxDays</H3><PRE>int <B>getMaxDays</B>()</PRE><DL><DD>Returns the maximum number of days to keep audit information. Once the limit has been reached audit files that contain information that exceed the limit will be deleted.<P><DD><DL><DT><B>Returns:</B><DD>the maximum number of days to keep audit information or -1 for unlimited</DL></DD></DL><HR><A NAME="setMaxDays(int)"><!-- --></A><H3>setMaxDays</H3><PRE>void <B>setMaxDays</B>(int count)</PRE><DL><DD>Set the the maximum number of days to keep audit information.<P><DD><DL><DT><B>Parameters:</B><DD><CODE>count</CODE> - the maximum number of days to keep audit information or -1 for unlimited</DL></DD></DL><HR><A NAME="getLogTimeout()"><!-- --></A><H3>getLogTimeout</H3><PRE>int <B>getLogTimeout</B>()</PRE><DL><DD>Returns the time in milliseconds between successive executions of the task that will save the queued audited packets to a permanent store.<P><DD><DL><DT><B>Returns:</B><DD>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="setLogTimeout(int)"><!-- --></A><H3>setLogTimeout</H3><PRE>void <B>setLogTimeout</B>(int logTimeout)</PRE><DL><DD>Sets the time in milliseconds between successive executions of the task that will save the queued audited packets to a permanent store.<P>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -