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 */
026package org.opends.server.admin.std.server;
027
028
029
030import java.util.SortedSet;
031import org.opends.server.admin.server.ConfigurationChangeListener;
032
033
034
035/**
036 * A server-side interface for querying Core Schema settings.
037 * <p>
038 * Core Schema define the core schema elements to load.
039 */
040public interface CoreSchemaCfg extends SchemaProviderCfg {
041
042  /**
043   * Gets the configuration class associated with this Core Schema.
044   *
045   * @return Returns the configuration class associated with this Core Schema.
046   */
047  Class<? extends CoreSchemaCfg> configurationClass();
048
049
050
051  /**
052   * Register to be notified when this Core Schema is changed.
053   *
054   * @param listener
055   *          The Core Schema configuration change listener.
056   */
057  void addCoreSchemaChangeListener(ConfigurationChangeListener<CoreSchemaCfg> listener);
058
059
060
061  /**
062   * Deregister an existing Core Schema configuration change listener.
063   *
064   * @param listener
065   *          The Core Schema configuration change listener.
066   */
067  void removeCoreSchemaChangeListener(ConfigurationChangeListener<CoreSchemaCfg> listener);
068
069
070
071  /**
072   * Gets the "allow-zero-length-values-directory-string" property.
073   * <p>
074   * Indicates whether zero-length (that is, an empty string) values
075   * are allowed for directory string.
076   * <p>
077   * This is technically not allowed by the revised LDAPv3
078   * specification, but some environments may require it for backward
079   * compatibility with servers that do allow it.
080   *
081   * @return Returns the value of the "allow-zero-length-values-directory-string" property.
082   */
083  boolean isAllowZeroLengthValuesDirectoryString();
084
085
086
087  /**
088   * Gets the "disabled-matching-rule" property.
089   * <p>
090   * The set of disabled matching rules.
091   * <p>
092   * Matching rules must be specified using the syntax: OID, or use
093   * the default value 'NONE' to specify no value.
094   *
095   * @return Returns an unmodifiable set containing the values of the "disabled-matching-rule" property.
096   */
097  SortedSet<String> getDisabledMatchingRule();
098
099
100
101  /**
102   * Gets the "disabled-syntax" property.
103   * <p>
104   * The set of disabled syntaxes.
105   * <p>
106   * Syntaxes must be specified using the syntax: OID, or use the
107   * default value 'NONE' to specify no value.
108   *
109   * @return Returns an unmodifiable set containing the values of the "disabled-syntax" property.
110   */
111  SortedSet<String> getDisabledSyntax();
112
113
114
115  /**
116   * Gets the "java-class" property.
117   * <p>
118   * Specifies the fully-qualified name of the Java class that
119   * provides the Core Schema implementation.
120   *
121   * @return Returns the value of the "java-class" property.
122   */
123  String getJavaClass();
124
125
126
127  /**
128   * Gets the "strict-format-country-string" property.
129   * <p>
130   * Indicates whether or not country code values are required to
131   * strictly comply with the standard definition for this syntax.
132   * <p>
133   * When set to false, country codes will not be validated and, as a
134   * result any string containing 2 characters will be acceptable.
135   *
136   * @return Returns the value of the "strict-format-country-string" property.
137   */
138  boolean isStrictFormatCountryString();
139
140
141
142  /**
143   * Gets the "strip-syntax-min-upper-bound-attribute-type-description" property.
144   * <p>
145   * Indicates whether the suggested minimum upper bound appended to
146   * an attribute's syntax OID in it's schema definition Attribute Type
147   * Description is stripped off.
148   * <p>
149   * When retrieving the server's schema, some APIs (JNDI) fail in
150   * their syntax lookup methods, because they do not parse this value
151   * correctly. This configuration option allows the server to be
152   * configured to provide schema definitions these APIs can parse
153   * correctly.
154   *
155   * @return Returns the value of the "strip-syntax-min-upper-bound-attribute-type-description" property.
156   */
157  boolean isStripSyntaxMinUpperBoundAttributeTypeDescription();
158
159}