org.jwall.web.audit.io

Interface AuditEventReader

All Superinterfaces:

Iterable<AuditEvent>

All Known Implementing Classes:

AbstractAuditEventReader, AccessLogAuditReader, AuditEventQueue, ConcurrentAuditReader, ConcurrentDirectoryReader, IronBeeAuditReader, ModSecurity2AuditReader, ModSecurity2AuditStream, ModSecurity2AuditStream, ModSecurityAuditReader, SyslogAuditEventMultiStream, SyslogAuditEventStream

public interface AuditEventReader
extends Iterable<AuditEvent>

This interface defines the methods of an abstract event-reader. All readers must implement the method readNext() which is used to read the next event from the underlying source (i.e. file).

Author:

Christian Bockermann <chris@jwall.org>

Method Summary

Methods

Modifier and Type	Method and Description
boolean	atEOF()
long	bytesAvailable()
long	bytesRead()
void	close()
AuditEvent	readNext() This method tries to read the next event that is available.

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

readNext

AuditEvent readNext()
                    throws IOException,
                           ParseException

This method tries to read the next event that is available.

Returns:

The next audit-event from or NULL if no event is available.

Throws:

IOException

ParseException

close

void close()
           throws IOException

Throws:

IOException

atEOF

boolean atEOF()

bytesRead

long bytesRead()

bytesAvailable

long bytesAvailable()