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.InvalidNameException;
024    
025    import org.apache.directory.shared.ldap.message.ResultCodeEnum;
026    
027    
028    /**
029     * A subclass of InvalidNameException designed to hold an unequivocal LDAP
030     * result code.
031     * 
032     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
033     * @version $Rev: 437007 $
034     */
035    public class LdapInvalidNameException extends InvalidNameException implements LdapException
036    {
037        static final long serialVersionUID = 1922458280238058561L;
038    
039        /** the LDAP resultCode this exception is associated with */
040        private final ResultCodeEnum resultCode;
041    
042    
043        /**
044         * Creates an Eve NamingException.
045         * 
046         * @param resultCode
047         *            the LDAP resultCode this exception is associated with
048         */
049        public LdapInvalidNameException(ResultCodeEnum resultCode)
050        {
051            this.resultCode = resultCode;
052        }
053    
054    
055        /**
056         * Creates an Eve NamingException.
057         * 
058         * @param explanation
059         *            an explanation for the failure
060         * @param resultCode
061         *            the LDAP resultCode this exception is associated with
062         */
063        public LdapInvalidNameException(String explanation, ResultCodeEnum resultCode)
064        {
065            super( explanation );
066            this.resultCode = resultCode;
067        }
068    
069    
070        /**
071         * Gets the LDAP resultCode this exception is associated with.
072         * 
073         * @return the LDAP resultCode this exception is associated with
074         */
075        public ResultCodeEnum getResultCode()
076        {
077            return resultCode;
078        }
079    }