com.unboundid.ldap.sdk.unboundidds.logs.v2

Interface AccessLogReader

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, LogReader

All Known Implementing Classes:

JSONAccessLogReader, TextFormattedAccessLogReader

@NotExtensible
 @ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public interface AccessLogReader
extends LogReader

This class defines an API for reading access log messages.

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.

Method Summary

Modifier and Type	Method and Description
AccessLogMessage	readMessage() Reads a log message.

Methods inherited from interface com.unboundid.ldap.sdk.unboundidds.logs.v2.LogReader

close

Method Detail

readMessage

@Nullable
AccessLogMessage readMessage()
                                throws java.io.IOException,
                                       LogException

Reads a log message.

Specified by:

readMessage in interface LogReader

Returns:

The log message that was read, or null if the end of the log has been reached.

Throws:

java.io.IOException - If a problem occurs while attempting to read from the log. If this exception is thrown, then it will not be possible to continue reading from the log, and the reader will have been closed.

LogException - If a problem occurs while attempting to parse a message that was read from the log. If this exception is thrown, then you may continue attempting to read from the log.