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 ForgeRock AS.
016 */
017
018package org.opends.server.admin;
019
020import static org.opends.messages.AdminMessages.*;
021
022
023/**
024 * Thrown when an attempt is made to retrieve a property using its name but the
025 * name was not recognized.
026 * <p>
027 * This exception can occur when attempt is made to retrieve inherited default
028 * values from a managed object.
029 */
030public class PropertyNotFoundException extends OperationsException {
031
032  /**
033   * Serialization ID.
034   */
035  private static final long serialVersionUID = -895548482881819610L;
036
037  /** The name of the property that could not be found. */
038  private final String propertyName;
039
040
041
042  /**
043   * Create a new property not found exception.
044   *
045   * @param propertyName
046   *          The name of the property that could not be found.
047   */
048  public PropertyNotFoundException(String propertyName) {
049    super(ERR_PROPERTY_NOT_FOUND_EXCEPTION.get(propertyName));
050
051    this.propertyName = propertyName;
052  }
053
054
055
056  /**
057   * Get the name of the property that could not be found.
058   *
059   * @return Returns the name of the property that could not be found.
060   */
061  public String getPropertyName() {
062    return propertyName;
063  }
064
065}