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.ldap.message.ResultCodeEnum;
024    import org.apache.directory.shared.ldap.name.DN;
025    
026    
027    /**
028     * An class for LDAP operation exceptions which add LDAP specific information to
029     * Exceptions.
030     * 
031     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
032     * @version $Rev: 437007 $
033     */
034    public class LdapOperationException extends LdapException
035    {
036        /** The serial version UUID */
037        private static final long serialVersionUID = 1L;
038    
039        /** The operation resultCode */
040        protected ResultCodeEnum resultCode;
041        
042        /** The resolved DN */
043        protected DN resolvedDn;
044    
045        /**
046         * @return the resolvedDn
047         */
048        public DN getResolvedDn()
049        {
050            return resolvedDn;
051        }
052    
053    
054        /**
055         * @param resolvedDn the resolvedDn to set
056         */
057        public void setResolvedDn( DN resolvedDn )
058        {
059            this.resolvedDn = resolvedDn;
060        }
061    
062    
063        /**
064         * Creates a new instance of LdapOperationException.
065         *
066         * @param resultCode The operation resultCode
067         * @param message The exception message
068         */
069        public LdapOperationException( ResultCodeEnum resultCode, String message )
070        {
071            super( message );
072            this.resultCode = resultCode;
073        }
074    
075        
076        /**
077         * Creates a new instance of LdapOperationException.
078         *
079         * @param message The exception message
080         */
081        public LdapOperationException( String message )
082        {
083            super( message );
084        }
085        
086        
087        /**
088         * Gets the LDAP result code that would be associated with this exception.
089         * 
090         * @return the LDAP result code corresponding to this exception type.
091         */
092        public ResultCodeEnum getResultCode()
093        {
094            return resultCode;
095        }
096    }