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