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.DirectoryStringAttributeSyntaxCfg;
033
034
035
036/**
037 * A client-side interface for reading and modifying Directory String
038 * Attribute Syntax settings.
039 * <p>
040 * The Directory String Attribute Syntax defines an attribute syntax
041 * for storing arbitrary string (and sometimes binary) data.
042 */
043public interface DirectoryStringAttributeSyntaxCfgClient extends AttributeSyntaxCfgClient {
044
045  /**
046   * Get the configuration definition associated with this Directory String Attribute Syntax.
047   *
048   * @return Returns the configuration definition associated with this Directory String Attribute Syntax.
049   */
050  ManagedObjectDefinition<? extends DirectoryStringAttributeSyntaxCfgClient, ? extends DirectoryStringAttributeSyntaxCfg> definition();
051
052
053
054  /**
055   * Gets the "allow-zero-length-values" property.
056   * <p>
057   * Indicates whether zero-length (that is, an empty string) values
058   * are allowed.
059   * <p>
060   * This is technically not allowed by the revised LDAPv3
061   * specification, but some environments may require it for backward
062   * compatibility with servers that do allow it.
063   *
064   * @return Returns the value of the "allow-zero-length-values" property.
065   */
066  boolean isAllowZeroLengthValues();
067
068
069
070  /**
071   * Sets the "allow-zero-length-values" property.
072   * <p>
073   * Indicates whether zero-length (that is, an empty string) values
074   * are allowed.
075   * <p>
076   * This is technically not allowed by the revised LDAPv3
077   * specification, but some environments may require it for backward
078   * compatibility with servers that do allow it.
079   *
080   * @param value The value of the "allow-zero-length-values" property.
081   * @throws PropertyException
082   *           If the new value is invalid.
083   */
084  void setAllowZeroLengthValues(Boolean value) throws PropertyException;
085
086
087
088  /**
089   * Gets the "java-class" property.
090   * <p>
091   * Specifies the fully-qualified name of the Java class that
092   * provides the Directory String Attribute Syntax implementation.
093   *
094   * @return Returns the value of the "java-class" property.
095   */
096  String getJavaClass();
097
098
099
100  /**
101   * Sets the "java-class" property.
102   * <p>
103   * Specifies the fully-qualified name of the Java class that
104   * provides the Directory String Attribute Syntax implementation.
105   * <p>
106   * This property is read-only and can only be modified during
107   * creation of a Directory String Attribute Syntax.
108   *
109   * @param value The value of the "java-class" property.
110   * @throws PropertyException
111   *           If the new value is invalid.
112   * @throws PropertyException
113   *           If this Directory String Attribute Syntax is not being initialized.
114   */
115  void setJavaClass(String value) throws PropertyException, PropertyException;
116
117}