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
010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012 * See the License for the specific language governing permissions
013 * and limitations under the License.
014 *
015 * When distributing Covered Code, include this CDDL HEADER in each
016 * file and include the License file at
017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
018 * add the following below this CDDL HEADER, with the fields enclosed
019 * by brackets "[]" replaced with your own identifying information:
020 * Portions Copyright [yyyy] [name of copyright owner]
021 *
022 * CDDL HEADER END
023 *
024 *
025 * Copyright 2008 Sun Microsystems, Inc.
026 */
027 package org.opends.server.admin.std.server;
028
029
030
031 import org.opends.server.admin.server.ConfigurationChangeListener;
032
033
034
035 /**
036 * A server-side interface for querying Attribute Type Description
037 * Attribute Syntax settings.
038 * <p>
039 * Attribute Type Description Attribute Syntaxes describe the format
040 * of the directory schema attribute type definitions.
041 */
042 public interface AttributeTypeDescriptionAttributeSyntaxCfg extends AttributeSyntaxCfg {
043
044 /**
045 * Gets the configuration class associated with this Attribute Type Description Attribute Syntax.
046 *
047 * @return Returns the configuration class associated with this Attribute Type Description Attribute Syntax.
048 */
049 Class<? extends AttributeTypeDescriptionAttributeSyntaxCfg> configurationClass();
050
051
052
053 /**
054 * Register to be notified when this Attribute Type Description Attribute Syntax is changed.
055 *
056 * @param listener
057 * The Attribute Type Description Attribute Syntax configuration change listener.
058 */
059 void addAttributeTypeDescriptionChangeListener(ConfigurationChangeListener<AttributeTypeDescriptionAttributeSyntaxCfg> listener);
060
061
062
063 /**
064 * Deregister an existing Attribute Type Description Attribute Syntax configuration change listener.
065 *
066 * @param listener
067 * The Attribute Type Description Attribute Syntax configuration change listener.
068 */
069 void removeAttributeTypeDescriptionChangeListener(ConfigurationChangeListener<AttributeTypeDescriptionAttributeSyntaxCfg> listener);
070
071
072
073 /**
074 * Gets the "java-class" property.
075 * <p>
076 * Specifies the fully-qualified name of the Java class that
077 * provides the Attribute Type Description Attribute Syntax
078 * implementation.
079 *
080 * @return Returns the value of the "java-class" property.
081 */
082 String getJavaClass();
083
084
085
086 /**
087 * Gets the "strip-syntax-min-upper-bound" property.
088 * <p>
089 * Indicates whether the suggested minimum upper bound appended to
090 * an attribute's syntax OID in it's schema definition Attribute Type
091 * Description is stripped off.
092 * <p>
093 * When retrieving the server's schema, some APIs (JNDI) fail in
094 * their syntax lookup methods, because they do not parse this value
095 * correctly. This configuration option allows the server to be
096 * configured to provide schema definitions these APIs can parse
097 * correctly.
098 *
099 * @return Returns the value of the "strip-syntax-min-upper-bound" property.
100 */
101 boolean isStripSyntaxMinUpperBound();
102
103 }