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