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