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