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