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.Closeable;
041import java.io.IOException;
042
043import com.unboundid.ldap.sdk.unboundidds.logs.LogException;
044import com.unboundid.util.NotExtensible;
045import com.unboundid.util.Nullable;
046import com.unboundid.util.ThreadSafety;
047import com.unboundid.util.ThreadSafetyLevel;
048
049
050
051/**
052 * This class defines an API for reading log messages.
053 * <BR>
054 * <BLOCKQUOTE>
055 *   <B>NOTE:</B>  This class, and other classes within the
056 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
057 *   supported for use against Ping Identity, UnboundID, and
058 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
059 *   for proprietary functionality or for external specifications that are not
060 *   considered stable or mature enough to be guaranteed to work in an
061 *   interoperable way with other types of LDAP servers.
062 * </BLOCKQUOTE>
063 */
064@NotExtensible()
065@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
066public interface LogReader
067       extends Closeable
068{
069  /**
070   * Reads a log message.
071   *
072   * @return  The log message that was read, or {@code null} if the end of the
073   *          log has been reached.
074   *
075   * @throws  IOException  If a problem occurs while attempting to read from the
076   *                       log.  If this exception is thrown, then it will not
077   *                       be possible to continue reading from the log, and the
078   *                       reader will have been closed.
079   *
080   * @throws  LogException  If a problem occurs while attempting to parse a
081   *                        message that was read from the log.  If this
082   *                        exception is thrown, then you may continue
083   *                        attempting to read from the log.
084   */
085  @Nullable()
086  LogMessage readMessage()
087             throws IOException, LogException;
088
089
090
091  /**
092   * Closes this log reader.
093   *
094   * @throws  IOException  If a problem occurs while closing the reader.
095   */
096  @Override()
097  void close()
098       throws IOException;
099}