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.client;
028
029
030
031 import org.opends.server.admin.IllegalPropertyValueException;
032 import org.opends.server.admin.ManagedObjectDefinition;
033 import org.opends.server.admin.PropertyIsReadOnlyException;
034 import org.opends.server.admin.std.server.AttributeTypeDescriptionAttributeSyntaxCfg;
035
036
037
038 /**
039 * A client-side interface for reading and modifying Attribute Type
040 * Description Attribute Syntax settings.
041 * <p>
042 * Attribute Type Description Attribute Syntaxes describe the format
043 * of the directory schema attribute type definitions.
044 */
045 public interface AttributeTypeDescriptionAttributeSyntaxCfgClient extends AttributeSyntaxCfgClient {
046
047 /**
048 * Get the configuration definition associated with this Attribute Type Description Attribute Syntax.
049 *
050 * @return Returns the configuration definition associated with this Attribute Type Description Attribute Syntax.
051 */
052 ManagedObjectDefinition<? extends AttributeTypeDescriptionAttributeSyntaxCfgClient, ? extends AttributeTypeDescriptionAttributeSyntaxCfg> definition();
053
054
055
056 /**
057 * Gets the "java-class" property.
058 * <p>
059 * Specifies the fully-qualified name of the Java class that
060 * provides the Attribute Type Description Attribute Syntax
061 * implementation.
062 *
063 * @return Returns the value of the "java-class" property.
064 */
065 String getJavaClass();
066
067
068
069 /**
070 * Sets the "java-class" property.
071 * <p>
072 * Specifies the fully-qualified name of the Java class that
073 * provides the Attribute Type Description Attribute Syntax
074 * implementation.
075 * <p>
076 * This property is read-only and can only be modified during
077 * creation of a Attribute Type Description Attribute Syntax.
078 *
079 * @param value The value of the "java-class" property.
080 * @throws IllegalPropertyValueException
081 * If the new value is invalid.
082 * @throws PropertyIsReadOnlyException
083 * If this Attribute Type Description Attribute Syntax is not being initialized.
084 */
085 void setJavaClass(String value) throws IllegalPropertyValueException, PropertyIsReadOnlyException;
086
087
088
089 /**
090 * Gets the "strip-syntax-min-upper-bound" property.
091 * <p>
092 * Indicates whether the suggested minimum upper bound appended to
093 * an attribute's syntax OID in it's schema definition Attribute Type
094 * Description is stripped off.
095 * <p>
096 * When retrieving the server's schema, some APIs (JNDI) fail in
097 * their syntax lookup methods, because they do not parse this value
098 * correctly. This configuration option allows the server to be
099 * configured to provide schema definitions these APIs can parse
100 * correctly.
101 *
102 * @return Returns the value of the "strip-syntax-min-upper-bound" property.
103 */
104 boolean isStripSyntaxMinUpperBound();
105
106
107
108 /**
109 * Sets the "strip-syntax-min-upper-bound" property.
110 * <p>
111 * Indicates whether the suggested minimum upper bound appended to
112 * an attribute's syntax OID in it's schema definition Attribute Type
113 * Description is stripped off.
114 * <p>
115 * When retrieving the server's schema, some APIs (JNDI) fail in
116 * their syntax lookup methods, because they do not parse this value
117 * correctly. This configuration option allows the server to be
118 * configured to provide schema definitions these APIs can parse
119 * correctly.
120 *
121 * @param value The value of the "strip-syntax-min-upper-bound" property.
122 * @throws IllegalPropertyValueException
123 * If the new value is invalid.
124 */
125 void setStripSyntaxMinUpperBound(Boolean value) throws IllegalPropertyValueException;
126
127 }