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
030
031
032import java.util.Collection;
033import java.util.Collections;
034
035
036
037/**
038 * An interface which can be used to initialize the contents of a managed
039 * object.
040 */
041public interface PropertyProvider {
042
043  /**
044   * A property provider which always returns empty property values, indicating
045   * default behavior.
046   */
047  PropertyProvider DEFAULT_PROVIDER =
048    new PropertyProvider() {
049
050    /** {@inheritDoc} */
051    public <T> Collection<T> getPropertyValues(PropertyDefinition<T> d)
052        throws IllegalArgumentException {
053      return Collections.<T> emptySet();
054    }
055
056  };
057
058
059
060  /**
061   * Get the property values associated with the specified property definition.
062   * <p>
063   * Implementations are not required to validate the values that they provide.
064   * Specifically:
065   * <ul>
066   * <li>they do not need to guarantee that the provided values are valid
067   * according to the property's syntax
068   * <li>they do not need to provide values for mandatory properties
069   * <li>they do not need to ensure that single-valued properties do contain at
070   * most one value.
071   * </ul>
072   * The returned set of values is allowed to contain duplicates.
073   *
074   * @param <T>
075   *          The underlying type of the property.
076   * @param d
077   *          The Property definition.
078   * @return Returns a newly allocated set containing a copy of the property's
079   *         values. An empty set indicates that the property has no values
080   *         defined and any default behavior is applicable.
081   * @throws IllegalArgumentException
082   *           If this property provider does not recognise the requested
083   *           property definition.
084   */
085  <T> Collection<T> getPropertyValues(PropertyDefinition<T> d)
086      throws IllegalArgumentException;
087}