org.jwall.web.audit
Interface AuditEventView

All Superinterfaces:

EventView<AuditEvent>

public interface AuditEventView
extends EventView<AuditEvent>

This interface defines all method that are accessible by a user for investigating events contained in an event store. Typically implementations of this interface are acquired by looking up the remote store and querying a view instance using a users credentials.

The view returned by the store then contains all events that are viewable by that specific user.

Author:

Christian Bockermann <chris@jwall.org>

Method Summary

boolean	contains(AuditEvent e)
Long	count(AuditEventFilter filter) This method will return the number of events which match the given filter filter AND the user-specific implicit filter expressions.
boolean	delete(Integer id)
AuditEvent	getEvent(Integer id) This method will return the complete audit-event from the storage.
AuditEvent	getEvent(String id) This method will return the complete audit-event from the storage.
InputStream	getEventAsStream(Integer id)
AuditEvent	getEventEntry(Integer id) This method will retrieve the entry with the given id from the index or null if no entry exists with that id.
ByteBuffer	getEventRaw(Integer id)
List<AuditEventMessage>	getLastAlertMessages(int max)
Set<String>	getTags()
Set<String>	getTagsByEventId(Integer id)
Set<String>	getTagsByUser(String user)
Set<String>	getVariables() This method returns the variable names which are supported for filtering by this view.
Iterator<Integer>	iterator(AuditEventFilter filter) Creates an iterator over all event entries matching the given filter.
List<AuditEvent>	list(AuditEventFilter filter, int offset, int num)
List<AuditEvent>	list(AuditEventFilter filter, List<String> order, int offset, int num)
void	tag(AuditEventFilter filter, String user, List<String> tags)
void	tag(Integer eventId, String user, List<String> tags)
void	untag(AuditEventFilter filter, String user, List<String> tags)
void	untag(Integer eventId, String user, List<String> tags)

Methods inherited from interface org.jwall.audit.EventView

count, count, delete, delete, get, getCompletions, getIndexedVariables, getSupportedOperators, list, tag, untag

Method Detail

contains

boolean contains(AuditEvent e)

count

Long count(AuditEventFilter filter)
           throws Exception

This method will return the number of events which match the given filter filter AND the user-specific implicit filter expressions.

Parameters:

filter - The filter to select the events being counted.

Returns:

The number of events in this view, matching the given filter.

Throws:

RemoteException

Exception

getEvent

AuditEvent getEvent(Integer id)
                    throws Exception

This method will return the complete audit-event from the storage. This may require loading the event from the event-storage (e.g. disk), which may take more time than just fetching the event-entry.

Parameters:

id -

Returns:

Throws:

RemoteException

Exception

getEvent

AuditEvent getEvent(String id)
                    throws Exception

This method will return the complete audit-event from the storage. The ID provided is expected to be the event ID provided by ModSecurity and used by ModSecurity within the section separators.

Parameters:

id -

Returns:

Throws:

Exception

delete

boolean delete(Integer id)
               throws Exception

Throws:

Exception

getEventEntry

AuditEvent getEventEntry(Integer id)
                         throws Exception

This method will retrieve the entry with the given id from the index or null if no entry exists with that id.

Parameters:

id -

Returns:

Throws:

Exception

getEventRaw

ByteBuffer getEventRaw(Integer id)

getEventAsStream

InputStream getEventAsStream(Integer id)

iterator

Iterator<Integer> iterator(AuditEventFilter filter)
                           throws Exception

Creates an iterator over all event entries matching the given filter. The iterator supports the remove() method, but this does not have an effect on the database.

Parameters:

filter -

Returns:

Throws:

Exception

getLastAlertMessages

List<AuditEventMessage> getLastAlertMessages(int max)
                                             throws Exception

Throws:

Exception

getVariables

Set<String> getVariables()

Description copied from interface: EventView

This method returns the variable names which are supported for filtering by this view.

Specified by:

getVariables in interface EventView<AuditEvent>

Returns:

getTags

Set<String> getTags()
                    throws Exception

Throws:

Exception

getTagsByEventId

Set<String> getTagsByEventId(Integer id)

getTagsByUser

Set<String> getTagsByUser(String user)

list

List<AuditEvent> list(AuditEventFilter filter,
                      int offset,
                      int num)

list

List<AuditEvent> list(AuditEventFilter filter,
                      List<String> order,
                      int offset,
                      int num)

tag

void tag(Integer eventId,
         String user,
         List<String> tags)

tag

void tag(AuditEventFilter filter,
         String user,
         List<String> tags)

untag

void untag(Integer eventId,
           String user,
           List<String> tags)

untag

void untag(AuditEventFilter filter,
           String user,
           List<String> tags)