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 org.apache.directory.shared.i18n.I18n;
024    import org.apache.directory.shared.ldap.message.ResultCodeEnum;
025    
026    
027    /**
028     * An LDAPException that extends the {@link LdapOperationException} 
029     * carrying with it the corresponding result codes for this condition.
030     *
031     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
032     * @version $Rev$
033     */
034    public class LdapUnwillingToPerformException extends LdapOperationException
035    {
036        /** The serial version UUID */
037        static final long serialVersionUID = 1L;
038        
039        /**
040         * Creates a new instance of LdapUnwillingToPerformException.
041         *
042         * @param resultCode the ResultCodeEnum for this exception
043         * @param message The exception message
044         */
045        public LdapUnwillingToPerformException( ResultCodeEnum resultCode, String message )
046        {
047            super( message );
048            checkResultCode( resultCode );
049            this.resultCode = resultCode;
050        }
051    
052    
053        /**
054         * Creates a new instance of LdapUnwillingToPerformException.
055         * 
056         * @param resultCode the ResultCodeEnum for this exception
057         */
058        public LdapUnwillingToPerformException( ResultCodeEnum resultCode )
059        {
060            super( null );
061            checkResultCode( resultCode );
062            this.resultCode = resultCode;
063        }
064    
065    
066        /**
067         * Checks to make sure the resultCode value is right for this exception
068         * type.
069         * 
070         * @throws IllegalArgumentException
071         *             if the result code is not one of
072         *             {@link ResultCodeEnum#UNWILLING_TO_PERFORM},
073         *             {@link ResultCodeEnum#UNAVAILABLE_CRITICAL_EXTENSION}.
074         */
075        private void checkResultCode( ResultCodeEnum resultCode )
076        {
077            switch ( resultCode )
078            {
079                case UNWILLING_TO_PERFORM :
080                case UNAVAILABLE_CRITICAL_EXTENSION :
081                    return;
082                    
083                default:
084                    throw new IllegalArgumentException( I18n.err( I18n.ERR_04140, resultCode ) );
085            }
086        }
087    }