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.shared.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     * The constructor with a reason string argument.
034     * 
035     * @param reason the reason
036     * @param cause the root cause
037     */
038    public LdapUriException( String reason, Throwable cause )
039    {
040        super( reason, cause ); // for backward compatibility of Throwable
041        this.reason = reason;
042        this.reasonCode = UNKNOWN;
043    }
044
045    /**
046     * No specified reason code.
047     */
048    public static final int UNKNOWN = 0;
049
050    /**
051     * The URI parsing error.
052     */
053    // public static final int PARSING = 1;
054
055    /**
056     * The unsupported character encoding.
057     */
058    // public static final int UNSUPPORTED_ENCODING = 2;
059
060    /**
061     * The URI escape encoding and decoding error.
062     */
063    // public static final int ESCAPING = 3;
064
065    /**
066     * The DNS punycode encoding or decoding error.
067     */
068    // public static final int PUNYCODE = 4;
069    /**
070     * The reason code.
071     */
072    protected int reasonCode;
073
074    /**
075     * The reason message.
076     */
077    protected String reason;
078
079
080    /**
081     * Get the reason code.
082     * 
083     * @return the reason code
084     */
085    public int getReasonCode()
086    {
087        return reasonCode;
088    }
089}