001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2008 Sun Microsystems, Inc.
015 * Portions Copyright 2015-2016 ForgeRock AS.
016 */
017package org.forgerock.opendj.config;
018
019import static com.forgerock.opendj.ldap.config.ConfigMessages.*;
020
021/**
022 * Thrown when an attempt is made to retrieve a property using its name but the
023 * name was not recognized.
024 * <p>
025 * This exception can occur when attempt is made to retrieve inherited default
026 * values from a managed object.
027 */
028public class PropertyNotFoundException extends OperationsException {
029
030    /** Serialization ID. */
031    private static final long serialVersionUID = -895548482881819610L;
032
033    /** The name of the property that could not be found. */
034    private final String propertyName;
035
036    /**
037     * Create a new property not found exception.
038     *
039     * @param propertyName
040     *            The name of the property that could not be found.
041     */
042    public PropertyNotFoundException(String propertyName) {
043        super(ERR_PROPERTY_NOT_FOUND_EXCEPTION.get(propertyName));
044
045        this.propertyName = propertyName;
046    }
047
048    /**
049     * Get the name of the property that could not be found.
050     *
051     * @return Returns the name of the property that could not be found.
052     */
053    public String getPropertyName() {
054        return propertyName;
055    }
056
057}