|
Openfire 3.7.1 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jivesoftware.openfire.security.SecurityAuditManager
public class SecurityAuditManager
The SecurityAuditManager manages the SecurityAuditProvider configured for this server, and provides a proper conduit for making security log entries and looking them up. Ideally there is no reason for outside classes to interact directly with a provider. The provider can be specified in system properties by adding:
Method Summary | |
---|---|
SecurityAuditEvent |
getEvent(Integer msgID)
Retrieves a specific event by ID in the form of a SecurityAuditEvent. |
List<SecurityAuditEvent> |
getEvents(String username,
Integer skipEvents,
Integer numEvents,
Date startTime,
Date endTime)
Retrieves security events that have occurred, filtered by the parameters passed. |
static SecurityAuditManager |
getInstance()
Returns a singleton instance of SecurityAuditManager. |
static SecurityAuditProvider |
getSecurityAuditProvider()
Returns the currently-installed SecurityAuditProvider. |
void |
logEvent(String username,
String summary,
String details)
Records a security event in the audit logs. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static SecurityAuditProvider getSecurityAuditProvider()
public static SecurityAuditManager getInstance()
public void logEvent(String username, String summary, String details)
username
- Username of user who performed the security event.summary
- Short description of the event, similar to a subject.details
- Detailed description of the event, can be null if not desired.public List<SecurityAuditEvent> getEvents(String username, Integer skipEvents, Integer numEvents, Date startTime, Date endTime) throws AuditWriteOnlyException
username
- Username of user to look up. Can be null for no username filtering.skipEvents
- Number of events to skip past (typically for paging). Can be null for first page.numEvents
- Number of events to retrieve. Can be null for "all" events.startTime
- Oldest date of range of events to retrieve. Can be null for forever.endTime
- Most recent date of range of events to retrieve. Can be null for "now".
AuditWriteOnlyException
- if provider can not be read from.public SecurityAuditEvent getEvent(Integer msgID) throws EventNotFoundException, AuditWriteOnlyException
msgID
- ID number of event to retrieve.
EventNotFoundException
- if event was not found.
AuditWriteOnlyException
- if provider can not be read from.
|
Openfire 3.7.1 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |