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