com.unboundid.ldap.sdk.unboundidds.logs.AuditLogException Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2009-2023 Ping Identity Corporation
 * All Rights Reserved.
 */
/*
 * Copyright 2009-2023 Ping Identity Corporation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/*
 * Copyright (C) 2009-2023 Ping Identity Corporation
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License (GPLv2 only)
 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see .
 */
package com.unboundid.ldap.sdk.unboundidds.logs;



import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import com.unboundid.util.LDAPSDKException;
import com.unboundid.util.NotMutable;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import com.unboundid.util.Validator;



/**
 * This class defines an exception that may be thrown if a problem occurs while
 * attempting to parse an audit log message.
 * 

 * 
 *   NOTE:  This class, and other classes within the
 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
 *   supported for use against Ping Identity, UnboundID, and
 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
 *   for proprietary functionality or for external specifications that are not
 *   considered stable or mature enough to be guaranteed to work in an
 *   interoperable way with other types of LDAP servers.
 * 
 */
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class AuditLogException
       extends LDAPSDKException
{
  /**
   * The serial version UID for this serializable class.
   */
  private static final long  serialVersionUID = -3928437646247214211L;



  // The malformed log message that triggered this exception.
  @NotNull private final List logMessageLines;



  /**
   * Creates a new audit log exception with the provided information.
   *
   * @param  logMessageLines  A list of the lines that comprise the audit log
   *                          message.  It must not be {@code null} but may be
   *                          empty.
   * @param  explanation      A message explaining the problem that occurred.
   *                          It must not be {@code null}.
   */
  public AuditLogException(@NotNull final List logMessageLines,
                           @NotNull final String explanation)
  {
    this(logMessageLines, explanation, null);
  }



  /**
   * Creates a new audit log exception with the provided information.
   *
   * @param  logMessageLines  A list of the lines that comprise the audit log
   *                          message.  It must not be {@code null} but may be
   *                          empty.
   * @param  explanation      A message explaining the problem that occurred.
   *                          It must not be {@code null}.
   * @param  cause            An underlying exception that triggered this
   *                          exception.
   */
  public AuditLogException(@NotNull final List logMessageLines,
                           @NotNull final String explanation,
                           @Nullable final Throwable cause)
  {
    super(explanation, cause);

    Validator.ensureNotNull(logMessageLines);
    Validator.ensureNotNull(explanation);

    this.logMessageLines =
         Collections.unmodifiableList(new ArrayList<>(logMessageLines));
  }



  /**
   * Retrieves a list of the lines that comprise the audit log message that
   * triggered this exception.
   *
   * @return  A list of the lines that comprise the audit log message that
   *          triggered this exception, or an empty list if no log message lines
   *          are available.
   */
  @NotNull()
  public List getLogMessageLines()
  {
    return logMessageLines;
  }
}