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