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
010     * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011     * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.types;
028    import org.opends.messages.Message;
029    
030    
031    
032    /**
033     * This class defines a base exception that should be extended by any
034     * exception that exposes a unique identifier for the associated
035     * message.
036     */
037    @org.opends.server.types.PublicAPI(
038         stability=org.opends.server.types.StabilityLevel.VOLATILE,
039         mayInstantiate=false,
040         mayExtend=false,
041         mayInvoke=true)
042    public abstract class IdentifiedException
043           extends OpenDsException
044    {
045      /**
046       * Creates a new identified exception.
047       */
048      protected IdentifiedException()
049      {
050        super();
051      }
052    
053    
054    
055      /**
056       * Creates a new identified exception with the provided information.
057       *
058       * @param  message  The message that explains the problem that
059       *                  occurred.
060       */
061      protected IdentifiedException(Message message)
062      {
063        super(message);
064      }
065    
066    
067    
068      /**
069       * Creates a new identified exception with the provided information.
070       *
071       * @param  cause  The underlying cause that triggered this
072       *                exception.
073       */
074      protected IdentifiedException(Throwable cause)
075      {
076        super(cause);
077      }
078    
079    
080    
081      /**
082       * Creates a new identified exception with the provided information.
083       *
084       * @param  message  The message that explains the problem that
085       *                  occurred.
086       * @param  cause    The underlying cause that triggered this
087       *                  exception.
088       */
089      protected IdentifiedException(Message message, Throwable cause)
090      {
091        super(message, cause);
092      }
093    
094    }
095