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