org.jivesoftware.openfire.security

Interface SecurityAuditProvider

All Known Implementing Classes:

DefaultSecurityAuditProvider

public interface SecurityAuditProvider

A SecurityAuditProvider handles storage and retrieval of security audit logs. If set to write-only, the logs are not viewable from Openfire's admin console. An optional URL can be provided for the location of where the logs can be viewed.

Author:

Daniel Henninger

Method Summary

Modifier and Type	Method and Description
boolean	blockGroupEvents() Returns true if the provider should not send group change (create, edit, delete, etc) related security events on through.
boolean	blockUserEvents() Returns true if the provider should not send user change (create, edit, delete, etc) related security events on through.
String	getAuditURL() Retrieves a URL that can be visited to read the logs audited by this provider.
SecurityAuditEvent	getEvent(Integer msgID) Retrieves a specific event by ID.
Integer	getEventCount() Retrieves number of events recorded.
List<SecurityAuditEvent>	getEvents(String username, Integer skipEvents, Integer numEvents, Date startTime, Date endTime) Retrieves security events that have occurred, filtered by the parameters passed.
boolean	isWriteOnly() Returns true if the provider logs can be read by Openfire for display from Openfire's own admin interface.
void	logEvent(String username, String summary, String details) Records a security event in the audit logs.

Method Detail

logEvent

void logEvent(String username,
              String summary,
              String details)

Records a security event in the audit logs.

Parameters:

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.

getEvents

List<SecurityAuditEvent> getEvents(String username,
                                   Integer skipEvents,
                                   Integer numEvents,
                                   Date startTime,
                                   Date endTime)

Retrieves security events that have occurred, filtered by the parameters passed. The events will be in order of most recent to least recent. The provider is expected to create and fill out to the best of it's knowledge a list of SecurityAuditEvent objects. Any parameters that are left null are to be ignored. In other words, if username is null, then no specific username is being searched for.

Parameters:

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".

Returns:

Array of security events.

getEvent

SecurityAuditEvent getEvent(Integer msgID)
                     throws EventNotFoundException

Retrieves a specific event by ID. The provider is expected to create and fill out to the best of it's knowledge a SecurityAuditEvent object.

Parameters:

msgID - ID number of event to retrieve.

Returns:

SecurityAuditEvent object with information from retrieved event.

Throws:

EventNotFoundException - if event was not found.

getEventCount

Integer getEventCount()

Retrieves number of events recorded.

Returns:

Number of events that have been recorded.

isWriteOnly

boolean isWriteOnly()

Returns true if the provider logs can be read by Openfire for display from Openfire's own admin interface. If false, the administrative interface will place a stub in place to indicate that audit logs can not be read from this interface. The provider can specify a URL that will be displayed on this stub to point at where the logs can be read.

Returns:

True or false if the logs can be read remotely.

See Also:

getAuditURL()

getAuditURL

String getAuditURL()

Retrieves a URL that can be visited to read the logs audited by this provider. This is typically used if you are referring to another interface that displays the audit logs via another applications own interface. This is only useful if isWriteOnly is set to true. You can safely return null to this if you don't need it, and also if you simply do not have a URL for an audit viewer interface. The URL will only be referenced if it is not null.

Returns:

String represented URL that can be visited to view the audit logs.

See Also:

isWriteOnly()

blockUserEvents

boolean blockUserEvents()

Returns true if the provider should not send user change (create, edit, delete, etc) related security events on through. This is typically used if the service the provider is working with audits it's own user events and does not need Openfire to duplicate the event.

Returns:

True if we should block user related security audit events from being handled.

blockGroupEvents

boolean blockGroupEvents()

Returns true if the provider should not send group change (create, edit, delete, etc) related security events on through. This is typically used if the service the provider is working with audits it's own group events and does not need Openfire to duplicate the event.

Returns:

True if we should block group related security audit events from being handled.