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 org.opends.server.admin.server.ConfigurationChangeListener;
031
032
033
034/**
035 * A server-side interface for querying Attribute Type Description
036 * Attribute Syntax settings.
037 * <p>
038 * Attribute Type Description Attribute Syntaxes describe the format
039 * of the directory schema attribute type definitions.
040 */
041public interface AttributeTypeDescriptionAttributeSyntaxCfg extends AttributeSyntaxCfg {
042
043  /**
044   * Gets the configuration class associated with this Attribute Type Description Attribute Syntax.
045   *
046   * @return Returns the configuration class associated with this Attribute Type Description Attribute Syntax.
047   */
048  Class<? extends AttributeTypeDescriptionAttributeSyntaxCfg> configurationClass();
049
050
051
052  /**
053   * Register to be notified when this Attribute Type Description Attribute Syntax is changed.
054   *
055   * @param listener
056   *          The Attribute Type Description Attribute Syntax configuration change listener.
057   */
058  void addAttributeTypeDescriptionChangeListener(ConfigurationChangeListener<AttributeTypeDescriptionAttributeSyntaxCfg> listener);
059
060
061
062  /**
063   * Deregister an existing Attribute Type Description Attribute Syntax configuration change listener.
064   *
065   * @param listener
066   *          The Attribute Type Description Attribute Syntax configuration change listener.
067   */
068  void removeAttributeTypeDescriptionChangeListener(ConfigurationChangeListener<AttributeTypeDescriptionAttributeSyntaxCfg> listener);
069
070
071
072  /**
073   * Gets the "java-class" property.
074   * <p>
075   * Specifies the fully-qualified name of the Java class that
076   * provides the Attribute Type Description Attribute Syntax
077   * implementation.
078   *
079   * @return Returns the value of the "java-class" property.
080   */
081  String getJavaClass();
082
083
084
085  /**
086   * Gets the "strip-syntax-min-upper-bound" property.
087   * <p>
088   * Indicates whether the suggested minimum upper bound appended to
089   * an attribute's syntax OID in it's schema definition Attribute Type
090   * Description is stripped off.
091   * <p>
092   * When retrieving the server's schema, some APIs (JNDI) fail in
093   * their syntax lookup methods, because they do not parse this value
094   * correctly. This configuration option allows the server to be
095   * configured to provide schema definitions these APIs can parse
096   * correctly.
097   *
098   * @return Returns the value of the "strip-syntax-min-upper-bound" property.
099   */
100  boolean isStripSyntaxMinUpperBound();
101
102}