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