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
023import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
024
025
026/**
027 * A {@link LdapException} which associates a resultCode namely the
028 * {@link ResultCodeEnum#OTHER} resultCode with the exception.
029 * 
030 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
031 */
032public class LdapConfigurationException extends LdapOperationException
033{
034    /** The serial version UID */
035    static final long serialVersionUID = 1L;
036
037    /** The exception cause */
038    private Throwable cause;
039
040
041    /**
042     * Creates a new instance of LdapConfigurationException.
043     *
044     * @param message The exception message
045     */
046    public LdapConfigurationException( String message )
047    {
048        super( ResultCodeEnum.OTHER, message );
049    }
050
051
052    /**
053     * Creates a new instance of LdapConfigurationException.
054     */
055    public LdapConfigurationException()
056    {
057        super( ResultCodeEnum.OTHER, null );
058    }
059
060
061    /**
062     * Creates a new instance of LdapConfigurationException.
063     *
064     * @param message the exception message
065     * @param cause the cause
066     */
067    public LdapConfigurationException( String message, Throwable cause )
068    {
069        super( ResultCodeEnum.OTHER, message );
070        this.cause = cause;
071    }
072
073
074    /**
075     * @return the exception's cause
076     */
077    @Override
078    public Throwable getCause()
079    {
080        return cause;
081    }
082
083
084    /**
085     * Set the root cause.
086     *
087     * @param cause the cause
088     */
089    public void setCause( Throwable cause )
090    {
091        this.cause = cause;
092    }
093}