001    /*
002     *  Licensed to the Apache Software Foundation (ASF) under one
003     *  or more contributor license agreements.  See the NOTICE file
004     *  distributed with this work for additional information
005     *  regarding copyright ownership.  The ASF licenses this file
006     *  to you under the Apache License, Version 2.0 (the
007     *  "License"); you may not use this file except in compliance
008     *  with the License.  You may obtain a copy of the License at
009     *  
010     *    http://www.apache.org/licenses/LICENSE-2.0
011     *  
012     *  Unless required by applicable law or agreed to in writing,
013     *  software distributed under the License is distributed on an
014     *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     *  KIND, either express or implied.  See the License for the
016     *  specific language governing permissions and limitations
017     *  under the License. 
018     *  
019     */
020    package org.apache.directory.shared.ldap.exception;
021    
022    
023    import javax.naming.NamingException;
024    
025    import org.apache.directory.shared.ldap.message.ResultCodeEnum;
026    
027    
028    /**
029     * Extends the root NamingException by adding LDAP specific properties to it.
030     * 
031     * @see <a
032     *      href="http://java.sun.com/j2se/1.4.2/docs/guide/jndi/jndi-ldap-gl.html#EXCEPT">
033     *      LDAP ResultCode to JNDI Exception Mappings</a>
034     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
035     * @version $Rev: 437007 $
036     */
037    public class LdapNamingException extends NamingException implements LdapException
038    {
039        static final long serialVersionUID = -3777365681132844241L;
040    
041        /** the LDAP resultCode this exception is associated with */
042        private final ResultCodeEnum resultCode;
043    
044    
045        /**
046         * Creates an Eve NamingException.
047         * 
048         * @param resultCode
049         *            the LDAP resultCode this exception is associated with
050         */
051        public LdapNamingException(ResultCodeEnum resultCode)
052        {
053            super();
054    
055            this.resultCode = resultCode;
056        }
057    
058    
059        /**
060         * Creates an Eve NamingException.
061         * 
062         * @param explanation
063         *            an explanation for the failure
064         * @param resultCode
065         *            the LDAP resultCode this exception is associated with
066         */
067        public LdapNamingException(String explanation, ResultCodeEnum resultCode)
068        {
069            super( explanation );
070    
071            this.resultCode = resultCode;
072        }
073    
074    
075        /**
076         * Gets the LDAP resultCode this exception is associated with.
077         * 
078         * @return the LDAP resultCode this exception is associated with
079         */
080        public ResultCodeEnum getResultCode()
081        {
082            return this.resultCode;
083        }
084    }