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.server;
028    
029    
030    
031    import org.opends.server.admin.server.ConfigurationChangeListener;
032    
033    
034    
035    /**
036     * A server-side interface for querying Directory String Attribute
037     * Syntax settings.
038     * <p>
039     * The Directory String Attribute Syntax defines an attribute syntax
040     * for storing arbitrary string (and sometimes binary) data.
041     */
042    public interface DirectoryStringAttributeSyntaxCfg extends AttributeSyntaxCfg {
043    
044      /**
045       * Gets the configuration class associated with this Directory String Attribute Syntax.
046       *
047       * @return Returns the configuration class associated with this Directory String Attribute Syntax.
048       */
049      Class<? extends DirectoryStringAttributeSyntaxCfg> configurationClass();
050    
051    
052    
053      /**
054       * Register to be notified when this Directory String Attribute Syntax is changed.
055       *
056       * @param listener
057       *          The Directory String Attribute Syntax configuration change listener.
058       */
059      void addDirectoryStringChangeListener(ConfigurationChangeListener<DirectoryStringAttributeSyntaxCfg> listener);
060    
061    
062    
063      /**
064       * Deregister an existing Directory String Attribute Syntax configuration change listener.
065       *
066       * @param listener
067       *          The Directory String Attribute Syntax configuration change listener.
068       */
069      void removeDirectoryStringChangeListener(ConfigurationChangeListener<DirectoryStringAttributeSyntaxCfg> listener);
070    
071    
072    
073      /**
074       * Gets the "allow-zero-length-values" property.
075       * <p>
076       * Indicates whether zero-length (that is, an empty string) values
077       * are allowed.
078       * <p>
079       * This is technically not allowed by the revised LDAPv3
080       * specification, but some environments may require it for backward
081       * compatibility with servers that do allow it.
082       *
083       * @return Returns the value of the "allow-zero-length-values" property.
084       */
085      boolean isAllowZeroLengthValues();
086    
087    
088    
089      /**
090       * Gets the "java-class" property.
091       * <p>
092       * Specifies the fully-qualified name of the Java class that
093       * provides the Directory String Attribute Syntax implementation.
094       *
095       * @return Returns the value of the "java-class" property.
096       */
097      String getJavaClass();
098    
099    }