auditmanagerimpl.html

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

</DD>
<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>
public int <B>getMaxFileSize</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html#getMaxFileSize()">AuditManager</A></CODE></B></DD>
<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>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html#getMaxFileSize()">getMaxFileSize</A></CODE> in interface <CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html" title="interface in org.jivesoftware.openfire.audit">AuditManager</A></CODE></DL>
</DD>
<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>
public void <B>setMaxFileSize</B>(int&nbsp;size)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html#setMaxFileSize(int)">AuditManager</A></CODE></B></DD>
<DD>Set the maximum size of audit log files in megabytes.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html#setMaxFileSize(int)">setMaxFileSize</A></CODE> in interface <CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html" title="interface in org.jivesoftware.openfire.audit">AuditManager</A></CODE></DL>
</DD>
<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>
public int <B>getMaxDays</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html#getMaxDays()">AuditManager</A></CODE></B></DD>
<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>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html#getMaxDays()">getMaxDays</A></CODE> in interface <CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html" title="interface in org.jivesoftware.openfire.audit">AuditManager</A></CODE></DL>
</DD>
<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>
public void <B>setMaxDays</B>(int&nbsp;count)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html#setMaxDays(int)">AuditManager</A></CODE></B></DD>
<DD>Set the the maximum number of days to keep audit information.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html#setMaxDays(int)">setMaxDays</A></CODE> in interface <CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html" title="interface in org.jivesoftware.openfire.audit">AuditManager</A></CODE></DL>
</DD>
<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>
public int <B>getLogTimeout</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html#getLogTimeout()">AuditManager</A></CODE></B></DD>
<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>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html#getLogTimeout()">getLogTimeout</A></CODE> in interface <CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html" title="interface in org.jivesoftware.openfire.audit">AuditManager</A></CODE></DL>
</DD>
<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>
public void <B>setLogTimeout</B>(int&nbsp;logTimeout)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html#setLogTimeout(int)">AuditManager</A></CODE></B></DD>
<DD>Sets 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>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html#setLogTimeout(int)">setLogTimeout</A></CODE> in interface <CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html" title="interface in org.jivesoftware.openfire.audit">AuditManager</A></CODE></DL>
</DD>
<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>
public <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><B>Description copied from interface: <CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html#getLogDir()">AuditManager</A></CODE></B></DD>
<DD>Returns the absolute path to the directory where the audit log files will be saved.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html#getLogDir()">getLogDir</A></CODE> in interface <CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html" title="interface in org.jivesoftware.openfire.audit">AuditManager</A></CODE></DL>
</DD>
<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>
public 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><B>Description copied from interface: <CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html#setLogDir(java.lang.String)">AuditManager</A></CODE></B></DD>
<DD>Sets the absolute path to the directory where the audit log files will be saved.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html#setLogDir(java.lang.String)">setLogDir</A></CODE> in interface <CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html" title="interface in org.jivesoftware.openfire.audit">AuditManager</A></CODE></DL>
</DD>
<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>
public boolean <B>isAuditMessage</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html#isAuditMessage()">AuditManager</A></CODE></B></DD>
<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>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html#isAuditMessage()">isAuditMessage</A></CODE> in interface <CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html" title="interface in org.jivesoftware.openfire.audit">AuditManager</A></CODE></DL>
</DD>
<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>
public void <B>setAuditMessage</B>(boolean&nbsp;auditMessage)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html#setAuditMessage(boolean)">AuditManager</A></CODE></B></DD>
<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>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html#setAuditMessage(boolean)">setAuditMessage</A></CODE> in interface <CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html" title="interface in org.jivesoftware.openfire.audit">AuditManager</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>auditMessage</CODE> - True if all messages are to be audited</DL>
</DD>
</DL>
<HR>

<A NAME="isAuditPresence()"><!-- --></A><H3>
isAuditPresence</H3>
<PRE>
public boolean <B>isAuditPresence</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html#isAuditPresence()">AuditManager</A></CODE></B></DD>
<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>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html#isAuditPresence()">isAuditPresence</A></CODE> in interface <CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html" title="interface in org.jivesoftware.openfire.audit">AuditManager</A></CODE></DL>
</DD>
<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>
public void <B>setAuditPresence</B>(boolean&nbsp;auditPresence)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html#setAuditPresence(boolean)">AuditManager</A></CODE></B></DD>
<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>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html#setAuditPresence(boolean)">setAuditPresence</A></CODE> in interface <CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html" title="interface in org.jivesoftware.openfire.audit">AuditManager</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>auditPresence</CODE> - True if all presence are to be audited</DL>
</DD>
</DL>
<HR>

<A NAME="isAuditIQ()"><!-- --></A><H3>
isAuditIQ</H3>
<PRE>
public boolean <B>isAuditIQ</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html#isAuditIQ()">AuditManager</A></CODE></B></DD>
<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>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html#isAuditIQ()">isAuditIQ</A></CODE> in interface <CODE><A HREF="../../../../../org/jivesoftware/openfire/audit/AuditManager.html" title="interface in org.jivesoftware.openfire.audit">AuditManager</A></CODE></DL>
</DD>
<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>