001/*
002 * Copyright 2022-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2022-2024 Ping Identity Corporation
007 *
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *    http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020/*
021 * Copyright (C) 2022-2024 Ping Identity Corporation
022 *
023 * This program is free software; you can redistribute it and/or modify
024 * it under the terms of the GNU General Public License (GPLv2 only)
025 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
026 * as published by the Free Software Foundation.
027 *
028 * This program is distributed in the hope that it will be useful,
029 * but WITHOUT ANY WARRANTY; without even the implied warranty of
030 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
031 * GNU General Public License for more details.
032 *
033 * You should have received a copy of the GNU General Public License
034 * along with this program; if not, see <http://www.gnu.org/licenses>.
035 */
036package com.unboundid.ldap.sdk.unboundidds.logs.v2;
037
038
039
040import java.io.IOException;
041
042import com.unboundid.ldap.sdk.unboundidds.logs.LogException;
043import com.unboundid.util.NotExtensible;
044import com.unboundid.util.Nullable;
045import com.unboundid.util.ThreadSafety;
046import com.unboundid.util.ThreadSafetyLevel;
047
048
049
050/**
051 * This class defines an API for reading access log messages.
052 * <BR>
053 * <BLOCKQUOTE>
054 *   <B>NOTE:</B>  This class, and other classes within the
055 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
056 *   supported for use against Ping Identity, UnboundID, and
057 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
058 *   for proprietary functionality or for external specifications that are not
059 *   considered stable or mature enough to be guaranteed to work in an
060 *   interoperable way with other types of LDAP servers.
061 * </BLOCKQUOTE>
062 */
063@NotExtensible()
064@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
065public interface AccessLogReader
066       extends LogReader
067{
068  /**
069   * Reads a log message.
070   *
071   * @return  The log message that was read, or {@code null} if the end of the
072   *          log has been reached.
073   *
074   * @throws  IOException  If a problem occurs while attempting to read from the
075   *                       log.  If this exception is thrown, then it will not
076   *                       be possible to continue reading from the log, and the
077   *                       reader will have been closed.
078   *
079   * @throws  LogException  If a problem occurs while attempting to parse a
080   *                        message that was read from the log.  If this
081   *                        exception is thrown, then you may continue
082   *                        attempting to read from the log.
083   */
084  @Override()
085  @Nullable()
086  AccessLogMessage readMessage()
087       throws IOException, LogException;
088}