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 */
020package org.apache.directory.api.ldap.model.exception;
021
022
023/**
024 * The URI parsing and escape encoding exception.
025 * 
026 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
027 */
028public class LdapUriException extends LdapException
029{
030    private static final long serialVersionUID = 1L;
031
032
033    /**
034     * The constructor with a reason string argument.
035     * 
036     * @param reason the reason
037     * @param cause the root cause
038     */
039    public LdapUriException( String reason, Throwable cause )
040    {
041        // for backward compatibility of Throwable
042        super( reason, cause );
043        this.reason = reason;
044        this.reasonCode = UNKNOWN;
045    }
046
047    /**
048     * No specified reason code.
049     */
050    public static final int UNKNOWN = 0;
051
052    /**
053     * The reason code.
054     */
055    protected int reasonCode;
056
057    /**
058     * The reason message.
059     */
060    protected String reason;
061
062
063    /**
064     * Get the reason code.
065     * 
066     * @return the reason code
067     */
068    public int getReasonCode()
069    {
070        return reasonCode;
071    }
072}