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    import org.apache.directory.shared.i18n.I18n;
023    import org.apache.directory.shared.ldap.message.ResultCodeEnum;
024    
025    
026    /**
027     * A subclass of {@link LdapOperationException} designed to hold an unequivocal LDAP
028     * result code.
029     * 
030     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
031     * @version $Rev: 923834 $
032     */
033    public class LdapInvalidDnException extends LdapOperationException
034    {
035        /** The serial version UUID */
036        static final long serialVersionUID = 1L;
037    
038        
039        /**
040         * to be used by some special exceptions like TooComplexException
041         */
042        public LdapInvalidDnException( String message )
043        {
044            super( message );
045        }
046        
047        
048        /**
049         * Creates a new instance of LdapInvalidDnException.
050         *
051         * @param resultCode the ResultCodeEnum for this exception
052         * @param message The exception message
053         */
054        public LdapInvalidDnException(  ResultCodeEnum resultCode, String message )
055        {
056            super( message );
057            checkResultCode( resultCode );
058            this.resultCode = resultCode;
059        }
060    
061    
062        /**
063         * Creates a new instance of LdapInvalidDnException.
064         * 
065         * @param resultCode the ResultCodeEnum for this exception
066         */
067        public LdapInvalidDnException( ResultCodeEnum resultCode )
068        {
069            super( null );
070            checkResultCode( resultCode );
071            this.resultCode = resultCode;
072        }
073    
074    
075        /**
076         * Checks to make sure the resultCode value is right for this exception
077         * type.
078         * 
079         * @throws IllegalArgumentException
080         *             if the result code is not one of
081         *             {@link ResultCodeEnum#INVALID_DN_SYNTAX},
082         *             {@link ResultCodeEnum#NAMING_VIOLATION}.
083         */
084        private void checkResultCode( ResultCodeEnum resultCode )
085        {
086            switch ( resultCode )
087            {
088                case INVALID_DN_SYNTAX :
089                case NAMING_VIOLATION :
090                    return;
091                    
092                default:
093                    throw new IllegalArgumentException( I18n.err( I18n.ERR_04140, resultCode ) );
094            }
095        }
096    }