ldap/model/src/main/java/org/apache/directory/api/ldap/model/exception/LdapOperationException.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *  
 *    https://www.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License. 
 *  
 */
package org.apache.directory.api.ldap.model.exception;


import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
import org.apache.directory.api.ldap.model.name.Dn;


/**
 * An class for LDAP operation exceptions which add LDAP specific information to
 * Exceptions.
 * 
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
public class LdapOperationException extends LdapException
{
    /** The serial version UUID */
    private static final long serialVersionUID = 1L;

    /** The operation resultCode */
    protected ResultCodeEnum resultCode;

    /** The resolved Dn */
    protected Dn resolvedDn;

    /**
     * Creates a new instance of LdapOperationException.
     *
     * @param resultCode The operation resultCode
     * @param message The exception message
     */
    public LdapOperationException( ResultCodeEnum resultCode, String message )
    {
        super( message );
        this.resultCode = resultCode;
    }


    /**
     * Creates a new instance of LdapOperationException.
     *
     * @param resultCode The operation resultCode
     * @param message The exception message
     * @param cause The root cause for this exception
     */
    public LdapOperationException( ResultCodeEnum resultCode, String message, Throwable cause )
    {
        super( message, cause );
        this.resultCode = resultCode;
    }


    /**
     * Creates a new instance of LdapOperationException.
     *
     * @param message The exception message
     */
    public LdapOperationException( String message )
    {
        super( message );
    }


    /**
     * Creates a new instance of LdapOperationException.
     *
     * @param message The exception message
     * @param cause The root cause for this exception
     */
    public LdapOperationException( String message, Throwable cause )
    {
        super( message, cause );
    }


    /**
     * Gets the LDAP result code that would be associated with this exception.
     * 
     * @return the LDAP result code corresponding to this exception type.
     */
    public ResultCodeEnum getResultCode()
    {
        return resultCode;
    }


    /**
     * @return the resolvedDn
     */
    public Dn getResolvedDn()
    {
        return resolvedDn;
    }


    /**
     * @param resolvedDn the resolvedDn to set
     */
    public void setResolvedDn( Dn resolvedDn )
    {
        this.resolvedDn = resolvedDn;
    }
}