001/*
002 * Copyright 2009-2022 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2009-2022 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) 2009-2022 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;
037
038
039
040import java.io.BufferedReader;
041import java.io.Closeable;
042import java.io.File;
043import java.io.FileReader;
044import java.io.IOException;
045import java.io.Reader;
046
047import com.unboundid.util.NotMutable;
048import com.unboundid.util.NotNull;
049import com.unboundid.util.Nullable;
050import com.unboundid.util.ThreadSafety;
051import com.unboundid.util.ThreadSafetyLevel;
052
053
054
055/**
056 * This class provides a mechanism for reading messages from a Directory Server
057 * error log.
058 * <BR>
059 * <BLOCKQUOTE>
060 *   <B>NOTE:</B>  This class, and other classes within the
061 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
062 *   supported for use against Ping Identity, UnboundID, and
063 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
064 *   for proprietary functionality or for external specifications that are not
065 *   considered stable or mature enough to be guaranteed to work in an
066 *   interoperable way with other types of LDAP servers.
067 * </BLOCKQUOTE>
068 */
069@NotMutable()
070@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
071public final class ErrorLogReader
072       implements Closeable
073{
074  // The reader used to read the contents of the log file.
075  @NotNull private final BufferedReader reader;
076
077
078
079  /**
080   * Creates a new error log reader that will read messages from the specified
081   * log file.
082   *
083   * @param  path  The path of the log file to read.
084   *
085   * @throws  IOException  If a problem occurs while opening the file for
086   *                       reading.
087   */
088  public ErrorLogReader(@NotNull final String path)
089         throws IOException
090  {
091    reader = new BufferedReader(new FileReader(path));
092  }
093
094
095
096  /**
097   * Creates a new error log reader that will read messages from the specified
098   * log file.
099   *
100   * @param  file  The log file to read.
101   *
102   * @throws  IOException  If a problem occurs while opening the file for
103   *                       reading.
104   */
105  public ErrorLogReader(@NotNull final File file)
106         throws IOException
107  {
108    reader = new BufferedReader(new FileReader(file));
109  }
110
111
112
113  /**
114   * Creates a new error log reader that will read messages using the provided
115   * {@code Reader} object.
116   *
117   * @param  reader  The reader to use to read log messages.
118   */
119  public ErrorLogReader(@NotNull final Reader reader)
120  {
121    if (reader instanceof BufferedReader)
122    {
123      this.reader = (BufferedReader) reader;
124    }
125    else
126    {
127      this.reader = new BufferedReader(reader);
128    }
129  }
130
131
132
133  /**
134   * Reads the next error log message from the log file.
135   *
136   * @return  The error log message read from the log file, or {@code null} if
137   *          there are no more messages to be read.
138   *
139   * @throws  IOException  If an error occurs while trying to read from the
140   *                       file.
141   *
142   * @throws  LogException  If an error occurs while trying to parse the log
143   *                        message.
144   */
145  @Nullable()
146  public ErrorLogMessage read()
147         throws IOException, LogException
148  {
149    while (true)
150    {
151      final String line = reader.readLine();
152      if (line == null)
153      {
154        return null;
155      }
156
157      if (line.isEmpty() || (line.charAt(0) == '#'))
158      {
159        continue;
160      }
161
162      return new ErrorLogMessage(line);
163    }
164  }
165
166
167
168  /**
169   * Closes this error log reader.
170   *
171   * @throws  IOException  If a problem occurs while closing the reader.
172   */
173  @Override()
174  public void close()
175         throws IOException
176  {
177    reader.close();
178  }
179}