clearspacesecurityauditprovider.html

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

<A NAME="AUDIT_URL_PREFIX"><!-- --></A><H3>
AUDIT_URL_PREFIX</H3>
<PRE>
protected static final <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>AUDIT_URL_PREFIX</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.jivesoftware.openfire.clearspace.ClearspaceSecurityAuditProvider.AUDIT_URL_PREFIX">Constant Field Values</A></DL>
</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_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>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="ClearspaceSecurityAuditProvider()"><!-- --></A><H3>
ClearspaceSecurityAuditProvider</H3>
<PRE>
public <B>ClearspaceSecurityAuditProvider</B>()</PRE>
<DL>
<DD>Generate a ClearspaceSecurityAuditProvider instance.
<P>
</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="logEvent(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
logEvent</H3>
<PRE>
public 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>The ClearspaceSecurityAuditProvider will log events into Clearspace via the AuditService
 web service, provided by Clearspace.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/security/SecurityAuditProvider.html#logEvent(java.lang.String, java.lang.String, java.lang.String)">logEvent</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/security/SecurityAuditProvider.html" title="interface in org.jivesoftware.openfire.security">SecurityAuditProvider</A></CODE></DL>
</DD>
<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.<DT><B>See Also:</B><DD><A HREF="../../../../org/jivesoftware/openfire/security/SecurityAuditProvider.html#logEvent(java.lang.String, java.lang.String, java.lang.String)"><CODE>SecurityAuditProvider.logEvent(String, String, String)</CODE></A></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>
public <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>The ClearspaceSecurityAuditProvider does not retrieve audit entries from Clearspace.  Instead
 it refers the admin to a URL where they can read the logs.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/security/SecurityAuditProvider.html#getEvents(java.lang.String, java.lang.Integer, java.lang.Integer, java.util.Date, java.util.Date)">getEvents</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/security/SecurityAuditProvider.html" title="interface in org.jivesoftware.openfire.security">SecurityAuditProvider</A></CODE></DL>
</DD>
<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.<DT><B>See Also:</B><DD><A HREF="../../../../org/jivesoftware/openfire/security/SecurityAuditProvider.html#getEvents(java.lang.String, java.lang.Integer, java.lang.Integer, java.util.Date, java.util.Date)"><CODE>SecurityAuditProvider.getEvents(String, Integer, Integer, java.util.Date, java.util.Date)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getEvent(java.lang.Integer)"><!-- --></A><H3>
getEvent</H3>
<PRE>
public <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>The ClearspaceSecurityAuditProvider does not retrieve audit entries from Clearspace.  Instead
 it refers the admin to a URL where they can read the logs.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/security/SecurityAuditProvider.html#getEvent(java.lang.Integer)">getEvent</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/security/SecurityAuditProvider.html" title="interface in org.jivesoftware.openfire.security">SecurityAuditProvider</A></CODE></DL>
</DD>
<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.<DT><B>See Also:</B><DD><A HREF="../../../../org/jivesoftware/openfire/security/SecurityAuditProvider.html#getEvent(java.lang.Integer)"><CODE>SecurityAuditProvider.getEvent(Integer)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getEventCount()"><!-- --></A><H3>
getEventCount</H3>
<PRE>
public <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>The ClearspaceSecurityAuditProvider does not retrieve audit entries from Clearspace.  Instead
 it refers the admin to a URL where they can read the logs.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/security/SecurityAuditProvider.html#getEventCount()">getEventCount</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/security/SecurityAuditProvider.html" title="interface in org.jivesoftware.openfire.security">SecurityAuditProvider</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>Number of events that have been recorded.<DT><B>See Also:</B><DD><A HREF="../../../../org/jivesoftware/openfire/security/SecurityAuditProvider.html#getEventCount()"><CODE>SecurityAuditProvider.getEventCount()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="isWriteOnly()"><!-- --></A><H3>
isWriteOnly</H3>
<PRE>
public boolean <B>isWriteOnly</B>()</PRE>
<DL>
<DD>The ClearspaceSecurityAuditProvider does not retrieve audit entries from Clearspace.  Instead
 it refers the admin to a URL where they can read the logs.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/security/SecurityAuditProvider.html#isWriteOnly()">isWriteOnly</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/security/SecurityAuditProvider.html" title="interface in org.jivesoftware.openfire.security">SecurityAuditProvider</A></CODE></DL>
</DD>
<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#isWriteOnly()"><CODE>SecurityAuditProvider.isWriteOnly()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getAuditURL()"><!-- --></A><H3>
getAuditURL</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>getAuditURL</B>()</PRE>
<DL>
<DD>The ClearspaceSecurityAuditProvider does not retrieve audit entries from Clearspace.  Instead
 it refers the admin to a URL where they can read the logs.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/security/SecurityAuditProvider.html#getAuditURL()">getAuditURL</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/security/SecurityAuditProvider.html" title="interface in org.jivesoftware.openfire.security">SecurityAuditProvider</A></CODE></DL>
</DD>
<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#getAuditURL()"><CODE>SecurityAuditProvider.getAuditURL()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="blockUserEvents()"><!-- --></A><H3>
blockUserEvents</H3>
<PRE>
public boolean <B>blockUserEvents</B>()</PRE>
<DL>
<DD>Clearspace handles logging it's own user events.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/security/SecurityAuditProvider.html#blockUserEvents()">blockUserEvents</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/security/SecurityAuditProvider.html" title="interface in org.jivesoftware.openfire.security">SecurityAuditProvider</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>True if we should block user related security audit events from being handled.<DT><B>See Also:</B><DD><A HREF="../../../../org/jivesoftware/openfire/security/SecurityAuditProvider.html#blockUserEvents()"><CODE>SecurityAuditProvider.blockUserEvents()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="blockGroupEvents()"><!-- --></A><H3>
blockGroupEvents</H3>
<PRE>
public boolean <B>blockGroupEvents</B>()</PRE>
<DL>
<DD>Clearspace handles logging it's own group events.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/security/SecurityAuditProvider.html#blockGroupEvents()">blockGroupEvents</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/security/SecurityAuditProvider.html" title="interface in org.jivesoftware.openfire.security">SecurityAuditProvider</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>True if we should block group related security audit events from being handled.<DT><B>See Also:</B><DD><A HREF="../../../../org/jivesoftware/openfire/security/SecurityAuditProvider.html#blockGroupEvents()"><CODE>SecurityAuditProvider.blockGroupEvents()</CODE></A></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/clearspace/ClearspaceSaslServer.html" title="class in org.jivesoftware.openfire.clearspace"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/jivesoftware/openfire/clearspace/ClearspaceUserProvider.html" title="class in org.jivesoftware.openfire.clearspace"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/jivesoftware/openfire/clearspace/ClearspaceSecurityAuditProvider.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="ClearspaceSecurityAuditProvider.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;<A HREF="#constructor_summary">CONSTR</A>&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;<A HREF="#constructor_detail">CONSTR</A>&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>