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.TimeLimitExceededException;
024    
025    import org.apache.directory.shared.ldap.message.ResultCodeEnum;
026    
027    
028    /**
029     * A TiimeLimitExceededException which associates a resultCode namely the
030     * {@link ResultCodeEnum#SIZELIMITEXCEEDED} resultCode with the exception.
031     * 
032     * @see LdapException
033     * @see LdapSizeLimitExceededException
034     * @see <a
035     *      href="http://java.sun.com/j2se/1.4.2/docs/guide/jndi/jndi-ldap-gl.html#EXCEPT">
036     *      LDAP ResultCode to JNDI Exception Mappings</a>
037     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
038     * @version $Rev: 477298 $
039     */
040    public class LdapTimeLimitExceededException extends TimeLimitExceededException implements LdapException
041    {
042        static final long serialVersionUID = -8611970137960601723L;
043    
044    
045        /**
046         * @see TimeLimitExceededException#TimeLimitExceededException()
047         */
048        public LdapTimeLimitExceededException()
049        {
050            super();
051        }
052    
053    
054        /**
055         * @see TimeLimitExceededException#TimeLimitExceededException(String)
056         */
057        public LdapTimeLimitExceededException(String explanation)
058        {
059            super( explanation );
060        }
061    
062    
063        /**
064         * Always returns {@link ResultCodeEnum#TIMELIMITEXCEEDED}
065         * 
066         * @see LdapException#getResultCode()
067         */
068        public ResultCodeEnum getResultCode()
069        {
070            return ResultCodeEnum.TIME_LIMIT_EXCEEDED;
071        }
072    }