com.unboundid.ldap.sdk.unboundidds.logs

Class AuditLogReader

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.logs.AuditLogReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class AuditLogReader
extends java.lang.Object
implements java.io.Closeable

This class provides a mechanism for reading messages from a Directory Server audit log.

NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

Constructor Summary

Constructors

Constructor and Description
AuditLogReader(java.io.File file) Creates a new audit log reader that will read messages from the specified log file.
AuditLogReader(java.io.InputStream inputStream) Creates a new audit log reader that will read messages from the provided input stream.
AuditLogReader(java.io.Reader reader) Creates a new audit log reader that will read messages using the provided Reader object.
AuditLogReader(java.lang.String path) Creates a new audit log reader that will read messages from the specified log file.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this error log reader.
AuditLogMessage	read() Reads the next audit log message from the log file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuditLogReader

public AuditLogReader(@NotNull
                      java.lang.String path)
               throws java.io.IOException

Creates a new audit log reader that will read messages from the specified log file.

Parameters:

path - The path of the log file to read.

Throws:

java.io.IOException - If a problem occurs while opening the file for reading.

AuditLogReader

public AuditLogReader(@NotNull
                      java.io.File file)
               throws java.io.IOException

Creates a new audit log reader that will read messages from the specified log file.

Parameters:

file - The log file to read.

Throws:

java.io.IOException - If a problem occurs while opening the file for reading.

AuditLogReader

public AuditLogReader(@NotNull
                      java.io.Reader reader)

Creates a new audit log reader that will read messages using the provided Reader object.

Parameters:

reader - The reader to use to read log messages.

AuditLogReader

public AuditLogReader(@NotNull
                      java.io.InputStream inputStream)

Creates a new audit log reader that will read messages from the provided input stream.

Parameters:

inputStream - The input stream from which to read log messages.

Method Detail

read

@Nullable
public AuditLogMessage read()
                               throws java.io.IOException,
                                      AuditLogException

Reads the next audit log message from the log file.

Returns:

The audit log message read from the log file, or null if there are no more messages to be read.

Throws:

java.io.IOException - If an error occurs while trying to read from the file.

AuditLogException - If an error occurs while trying to parse the log message.

close

public void close()
           throws java.io.IOException

Closes this error log reader.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException - If a problem occurs while closing the reader.