MissingParentException.java

/**
 * Licensed to the Austrian Association for Software Tool Integration (AASTI)
 * under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership. The AASTI 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
 *
 *     http://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.openengsb.infrastructure.ldap;

import org.apache.directory.shared.ldap.model.name.Dn;

/**
 * Thrown upon trying to access a non-existing {@link Dn}. Unlike {@link NoSuchNodeException}, this exception indicates
 * that resolving the Dn failed at a level above its leaf.
 * */
public class MissingParentException extends InconsistentDITException {

    private static final long serialVersionUID = 8263832471990241311L;

    private final Dn lowestMatchedDn;

    /**
     * Pass the last existing Dn in the hierarchy so that catch blocks can find out where the failure occured.
     */
    public MissingParentException(Dn lowestMatchedDn) {
        super();
        this.lowestMatchedDn = lowestMatchedDn;
    }

    /**
     * Pass the last existing Dn in the hierarchy so that catch blocks can find out where the failure occured.
     */
    public MissingParentException(String message, Dn lowestMatchedDn) {
        super(message);
        this.lowestMatchedDn = lowestMatchedDn;
    }

    /**
     * Pass the last existing Dn in the hierarchy so that catch blocks can find out where the failure occured.
     */
    public MissingParentException(Throwable cause, Dn lowestMatchedDn) {
        super(cause);
        this.lowestMatchedDn = lowestMatchedDn;
    }

    /**
     * Pass the last existing Dn in the hierarchy so that catch blocks can find out where the failure occured.
     */
    public MissingParentException(String message, Throwable cause, Dn lowestMatchedDn) {
        super(message, cause);
        this.lowestMatchedDn = lowestMatchedDn;
    }

    /**
     * Returns the last existing Dn in the hierarchy.
     */
    public Dn getLowestMatchedDn() {
        return lowestMatchedDn;
    }

}