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