001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2008 Sun Microsystems, Inc.
015 */
016package org.forgerock.opendj.server.config.client;
017
018
019
020import org.forgerock.opendj.config.ManagedObjectDefinition;
021import org.forgerock.opendj.config.PropertyException;
022import org.forgerock.opendj.server.config.server.AttributeTypeDescriptionAttributeSyntaxCfg;
023
024
025
026/**
027 * A client-side interface for reading and modifying Attribute Type
028 * Description Attribute Syntax settings.
029 * <p>
030 * Attribute Type Description Attribute Syntaxes describe the format
031 * of the directory schema attribute type definitions.
032 */
033public interface AttributeTypeDescriptionAttributeSyntaxCfgClient extends AttributeSyntaxCfgClient {
034
035  /**
036   * Get the configuration definition associated with this Attribute Type Description Attribute Syntax.
037   *
038   * @return Returns the configuration definition associated with this Attribute Type Description Attribute Syntax.
039   */
040  ManagedObjectDefinition<? extends AttributeTypeDescriptionAttributeSyntaxCfgClient, ? extends AttributeTypeDescriptionAttributeSyntaxCfg> definition();
041
042
043
044  /**
045   * Gets the "java-class" property.
046   * <p>
047   * Specifies the fully-qualified name of the Java class that
048   * provides the Attribute Type Description Attribute Syntax
049   * implementation.
050   *
051   * @return Returns the value of the "java-class" property.
052   */
053  String getJavaClass();
054
055
056
057  /**
058   * Sets the "java-class" property.
059   * <p>
060   * Specifies the fully-qualified name of the Java class that
061   * provides the Attribute Type Description Attribute Syntax
062   * implementation.
063   * <p>
064   * This property is read-only and can only be modified during
065   * creation of a Attribute Type Description Attribute Syntax.
066   *
067   * @param value The value of the "java-class" property.
068   * @throws PropertyException
069   *           If the new value is invalid.
070   * @throws PropertyException
071   *           If this Attribute Type Description Attribute Syntax is not being initialized.
072   */
073  void setJavaClass(String value) throws PropertyException, PropertyException;
074
075
076
077  /**
078   * Gets the "strip-syntax-min-upper-bound" property.
079   * <p>
080   * Indicates whether the suggested minimum upper bound appended to
081   * an attribute's syntax OID in it's schema definition Attribute Type
082   * Description is stripped off.
083   * <p>
084   * When retrieving the server's schema, some APIs (JNDI) fail in
085   * their syntax lookup methods, because they do not parse this value
086   * correctly. This configuration option allows the server to be
087   * configured to provide schema definitions these APIs can parse
088   * correctly.
089   *
090   * @return Returns the value of the "strip-syntax-min-upper-bound" property.
091   */
092  boolean isStripSyntaxMinUpperBound();
093
094
095
096  /**
097   * Sets the "strip-syntax-min-upper-bound" property.
098   * <p>
099   * Indicates whether the suggested minimum upper bound appended to
100   * an attribute's syntax OID in it's schema definition Attribute Type
101   * Description is stripped off.
102   * <p>
103   * When retrieving the server's schema, some APIs (JNDI) fail in
104   * their syntax lookup methods, because they do not parse this value
105   * correctly. This configuration option allows the server to be
106   * configured to provide schema definitions these APIs can parse
107   * correctly.
108   *
109   * @param value The value of the "strip-syntax-min-upper-bound" property.
110   * @throws PropertyException
111   *           If the new value is invalid.
112   */
113  void setStripSyntaxMinUpperBound(Boolean value) throws PropertyException;
114
115}