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 Sun Microsystems, Inc.
025 *      Portions Copyright 2014 ForgeRock AS
026 */
027
028package org.opends.server.admin.client;
029
030
031
032import static org.opends.messages.AdminMessages.*;
033
034import org.forgerock.i18n.LocalizableMessage;
035
036
037
038/**
039 * This exception is thrown when a communications related problem
040 * occurs whilst interacting with the Directory Server. This may be
041 * caused by problems such as network partitioning, the unavailability
042 * of the Directory Server, or other failures on the client or server
043 * side.
044 */
045public class CommunicationException extends AdminClientException {
046
047  /**
048   * Serialization ID.
049   */
050  private static final long serialVersionUID = 9093195928501281027L;
051
052
053
054  /**
055   * Create a communication exception with a default message.
056   */
057  public CommunicationException() {
058    super(ERR_COMMUNICATION_EXCEPTION_DEFAULT.get());
059  }
060
061
062
063  /**
064   * Create a communication exception with a cause and a default
065   * message.
066   *
067   * @param cause
068   *          The cause.
069   */
070  public CommunicationException(Throwable cause) {
071    super(ERR_COMMUNICATION_EXCEPTION_DEFAULT_CAUSE.get(cause.getMessage()),
072        cause);
073  }
074
075
076
077  /**
078   * Create a communication exception with a message and cause.
079   *
080   * @param message
081   *          The message.
082   * @param cause
083   *          The cause.
084   */
085  public CommunicationException(LocalizableMessage message, Throwable cause) {
086    super(message, cause);
087  }
088
089
090
091  /**
092   * Create a communication exception with a message.
093   *
094   * @param message
095   *          The message.
096   */
097  public CommunicationException(LocalizableMessage message) {
098    super(message);
099  }
100}