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.util.ArrayList; 041import java.util.Collections; 042import java.util.List; 043 044import com.unboundid.util.LDAPSDKException; 045import com.unboundid.util.NotMutable; 046import com.unboundid.util.ThreadSafety; 047import com.unboundid.util.ThreadSafetyLevel; 048import com.unboundid.util.Validator; 049 050 051 052/** 053 * This class defines an exception that may be thrown if a problem occurs while 054 * attempting to parse an audit log message. 055 * <BR> 056 * <BLOCKQUOTE> 057 * <B>NOTE:</B> This class, and other classes within the 058 * {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only 059 * supported for use against Ping Identity, UnboundID, and 060 * Nokia/Alcatel-Lucent 8661 server products. These classes provide support 061 * for proprietary functionality or for external specifications that are not 062 * considered stable or mature enough to be guaranteed to work in an 063 * interoperable way with other types of LDAP servers. 064 * </BLOCKQUOTE> 065 */ 066@NotMutable() 067@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE) 068public final class AuditLogException 069 extends LDAPSDKException 070{ 071 /** 072 * The serial version UID for this serializable class. 073 */ 074 private static final long serialVersionUID = -3928437646247214211L; 075 076 077 078 // The malformed log message that triggered this exception. 079 private final List<String> logMessageLines; 080 081 082 083 /** 084 * Creates a new audit log exception with the provided information. 085 * 086 * @param logMessageLines A list of the lines that comprise the audit log 087 * message. It must not be {@code null} but may be 088 * empty. 089 * @param explanation A message explaining the problem that occurred. 090 * It must not be {@code null}. 091 */ 092 public AuditLogException(final List<String> logMessageLines, 093 final String explanation) 094 { 095 this(logMessageLines, explanation, null); 096 } 097 098 099 100 /** 101 * Creates a new audit log exception with the provided information. 102 * 103 * @param logMessageLines A list of the lines that comprise the audit log 104 * message. It must not be {@code null} but may be 105 * empty. 106 * @param explanation A message explaining the problem that occurred. 107 * It must not be {@code null}. 108 * @param cause An underlying exception that triggered this 109 * exception. 110 */ 111 public AuditLogException(final List<String> logMessageLines, 112 final String explanation, final Throwable cause) 113 { 114 super(explanation, cause); 115 116 Validator.ensureNotNull(logMessageLines); 117 Validator.ensureNotNull(explanation); 118 119 this.logMessageLines = 120 Collections.unmodifiableList(new ArrayList<>(logMessageLines)); 121 } 122 123 124 125 /** 126 * Retrieves a list of the lines that comprise the audit log message that 127 * triggered this exception. 128 * 129 * @return A list of the lines that comprise the audit log message that 130 * triggered this exception, or an empty list if no log message lines 131 * are available. 132 */ 133 public List<String> getLogMessageLines() 134 { 135 return logMessageLines; 136 } 137}