001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Portions Copyright 2013-2014 ForgeRock AS.
015 */
016package org.opends.server.replication.server.changelog.api;
017
018import org.forgerock.i18n.LocalizableMessage;
019import org.opends.server.types.OpenDsException;
020
021/**
022 * This class define an Exception that must be used when some error condition
023 * was detected in the changelog database that cannot be recovered
024 * automatically.
025 */
026public class ChangelogException extends OpenDsException
027{
028
029  /** Generated serialization ID. */
030  private static final long serialVersionUID = -8444837053769661394L;
031
032  /**
033   * Creates a new changelog exception with the provided information.
034   *
035   * @param message
036   *          The message that explains the problem that occurred.
037   */
038  public ChangelogException(LocalizableMessage message)
039  {
040    super(message);
041  }
042
043  /**
044   * Creates a new changelog exception with the provided information.
045   *
046   * @param cause
047   *          The underlying cause that triggered this exception.
048   */
049  public ChangelogException(Throwable cause)
050  {
051    super(cause);
052  }
053
054  /**
055   * Creates a new identified exception with the provided information.
056   *
057   * @param message
058   *          The message that explains the problem that occurred.
059   * @param cause
060   *          The underlying cause that triggered this exception.
061   */
062  public ChangelogException(LocalizableMessage message, Throwable cause)
063  {
064    super(message, cause);
065  }
066}