001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Portions Copyright 2015 ForgeRock AS
025 */
026package org.opends.server.replication.server.changelog.api;
027
028import javax.annotation.Generated;
029
030import org.forgerock.i18n.LocalizableMessage;
031
032/**
033 * This exception is thrown when a cursor that has been aborted is used.
034 * <p>
035 * A cursor can be aborted when it is open on a log file that
036 * must be purged or cleared.
037 */
038public class AbortedChangelogCursorException extends ChangelogException
039{
040
041  @Generated("Eclipse")
042  private static final long serialVersionUID = -2123770048083474999L;
043
044  /**
045   * Creates a new exception with the provided message.
046   *
047   * @param message
048   *          The message that explains the problem that occurred.
049   */
050  public AbortedChangelogCursorException(LocalizableMessage message)
051  {
052    super(message);
053  }
054
055  /**
056   * Creates a new exception with the provided cause.
057   *
058   * @param cause
059   *          The underlying cause that triggered this exception.
060   */
061  public AbortedChangelogCursorException(Throwable cause)
062  {
063    super(cause);
064  }
065
066  /**
067   * Creates a new exception with the provided message and cause.
068   *
069   * @param message
070   *          The message that explains the problem that occurred.
071   * @param cause
072   *          The underlying cause that triggered this exception.
073   */
074  public AbortedChangelogCursorException(LocalizableMessage message, Throwable cause)
075  {
076    super(message, cause);
077  }
078}