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 java.util.Collection;
031import java.util.SortedSet;
032import org.opends.server.admin.ConfigurationClient;
033import org.opends.server.admin.ManagedObjectDefinition;
034import org.opends.server.admin.PropertyException;
035import org.opends.server.admin.std.server.RootDSEBackendCfg;
036import org.opends.server.types.DN;
037
038
039
040/**
041 * A client-side interface for reading and modifying Root DSE Backend
042 * settings.
043 * <p>
044 * The Root DSE Backend contains the directory server root DSE.
045 */
046public interface RootDSEBackendCfgClient extends ConfigurationClient {
047
048  /**
049   * Get the configuration definition associated with this Root DSE Backend.
050   *
051   * @return Returns the configuration definition associated with this Root DSE Backend.
052   */
053  ManagedObjectDefinition<? extends RootDSEBackendCfgClient, ? extends RootDSEBackendCfg> definition();
054
055
056
057  /**
058   * Gets the "show-all-attributes" property.
059   * <p>
060   * Indicates whether all attributes in the root DSE are to be
061   * treated like user attributes (and therefore returned to clients by
062   * default) regardless of the directory server schema configuration.
063   *
064   * @return Returns the value of the "show-all-attributes" property.
065   */
066  Boolean isShowAllAttributes();
067
068
069
070  /**
071   * Sets the "show-all-attributes" property.
072   * <p>
073   * Indicates whether all attributes in the root DSE are to be
074   * treated like user attributes (and therefore returned to clients by
075   * default) regardless of the directory server schema configuration.
076   *
077   * @param value The value of the "show-all-attributes" property.
078   * @throws PropertyException
079   *           If the new value is invalid.
080   */
081  void setShowAllAttributes(boolean value) throws PropertyException;
082
083
084
085  /**
086   * Gets the "subordinate-base-dn" property.
087   * <p>
088   * Specifies the set of base DNs used for singleLevel, wholeSubtree,
089   * and subordinateSubtree searches based at the root DSE.
090   *
091   * @return Returns the values of the "subordinate-base-dn" property.
092   */
093  SortedSet<DN> getSubordinateBaseDN();
094
095
096
097  /**
098   * Sets the "subordinate-base-dn" property.
099   * <p>
100   * Specifies the set of base DNs used for singleLevel, wholeSubtree,
101   * and subordinateSubtree searches based at the root DSE.
102   *
103   * @param values The values of the "subordinate-base-dn" property.
104   * @throws PropertyException
105   *           If one or more of the new values are invalid.
106   */
107  void setSubordinateBaseDN(Collection<DN> values) throws PropertyException;
108
109}