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 *      Copyright 2008-2009 Sun Microsystems, Inc.
025 *      Portions Copyright 2014 ForgeRock AS
026 */
027
028package org.opends.server.tools.dsreplication;
029
030import org.forgerock.i18n.LocalizableMessage;
031import org.opends.server.types.OpenDsException;
032
033/**
034 * The exception that is thrown during the replication command-line execution.
035 *
036 */
037public class ReplicationCliException extends OpenDsException {
038  private static final long serialVersionUID = -8085682356609610678L;
039  private ReplicationCliReturnCode errorCode;
040
041  /**
042   * The constructor for the exception.
043   * @param message the localized message.
044   * @param errorCode the error code associated with this exception.
045   * @param cause the cause that generated this exception.
046   */
047  public ReplicationCliException(LocalizableMessage message,
048      ReplicationCliReturnCode errorCode,
049      Throwable cause)
050  {
051    super(message, cause);
052    this.errorCode = errorCode;
053  }
054
055  /**
056   * Returns the error code associated with this exception.
057   * @return the error code associated with this exception.
058   */
059  public ReplicationCliReturnCode getErrorCode()
060  {
061    return errorCode;
062  }
063}
064