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 2013-2014 ForgeRock AS.
026 */
027package org.opends.server.types;
028
029import java.util.List;
030import java.util.Map;
031
032/**
033 * This interface defines a set of methods that must be provided by a
034 * schema file element, which is a schema element that is loaded from
035 * a schema configuration file.
036 * <BR><BR>
037 * Note that this interface is not meant to be implemented by
038 * third-party code, and only the following classes should be
039 * considered schema file elements:
040 * <UL>
041 *   <LI>{@code org.opends.server.types.AttributeType}</LI>
042 *   <LI>{@code org.opends.server.types.ObjectClass}</LI>
043 *   <LI>{@code org.opends.server.types.NameForm}</LI>
044 *   <LI>{@code org.opends.server.types.DITContentRule}</LI>
045 *   <LI>{@code org.opends.server.types.DITStructureRule}</LI>
046 *   <LI>{@code org.opends.server.types.MatchingRuleUse}</LI>
047 * </UL>
048 */
049@org.opends.server.types.PublicAPI(
050     stability=org.opends.server.types.StabilityLevel.VOLATILE,
051     mayInstantiate=false,
052     mayExtend=false,
053     mayInvoke=true)
054public interface SchemaFileElement
055{
056
057  /**
058   * Retrieves the "extra" properties for this schema definition.
059   * <p>
060   * FIXME Contrary to the SDK, this method returns a modifiable Map.
061   *
062   * @return Returns a Map of the "extra" properties for this schema definition,
063   *         where the key is the property name and the value is a List of
064   *         Strings representing the property values.
065   *         Single valued properties have a List with a single element inside.
066   */
067  Map<String, List<String>> getExtraProperties();
068
069}