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 2015 ForgeRock AS.
015 */
016package org.opends.server.replication.server.changelog.api;
017
018import javax.annotation.Generated;
019
020import org.forgerock.i18n.LocalizableMessage;
021
022/**
023 * This exception is thrown when a cursor that has been aborted is used.
024 * <p>
025 * A cursor can be aborted when it is open on a log file that
026 * must be purged or cleared.
027 */
028public class AbortedChangelogCursorException extends ChangelogException
029{
030
031  @Generated("Eclipse")
032  private static final long serialVersionUID = -2123770048083474999L;
033
034  /**
035   * Creates a new exception with the provided message.
036   *
037   * @param message
038   *          The message that explains the problem that occurred.
039   */
040  public AbortedChangelogCursorException(LocalizableMessage message)
041  {
042    super(message);
043  }
044
045  /**
046   * Creates a new exception with the provided cause.
047   *
048   * @param cause
049   *          The underlying cause that triggered this exception.
050   */
051  public AbortedChangelogCursorException(Throwable cause)
052  {
053    super(cause);
054  }
055
056  /**
057   * Creates a new exception with the provided message and cause.
058   *
059   * @param message
060   *          The message that explains the problem that occurred.
061   * @param cause
062   *          The underlying cause that triggered this exception.
063   */
064  public AbortedChangelogCursorException(LocalizableMessage message, Throwable cause)
065  {
066    super(message, cause);
067  }
068}